ListCopyJobSummaries
Esta solicitud obtiene una lista de trabajos de copia creados o en ejecución en los 30 últimos días. Puede incluir los parámetros AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults o NextToken para filtrar los resultados.
La solicitud devuelve un resumen que contiene Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime y Count de los trabajos incluidos.
Sintaxis de la solicitud
GET /audit/copy-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MaxResults=MaxResults&MessageCategory=MessageCategory&NextToken=NextToken&ResourceType=ResourceType&State=State HTTP/1.1
Parámetros de solicitud del URI
La solicitud utiliza los siguientes parámetros URI.
- AccountId
-
Devuelve el recuento de trabajos de la cuenta especificada.
Si la solicitud se envía desde una cuenta de miembro o una cuenta que no forma parte de AWS Organizations, se devolverán los trabajos de la cuenta del solicitante.
Las cuentas raíz, de administrador y de administrador delegado pueden utilizar el valor ANY para devolver recuentos de trabajos de todas las cuentas de la organización.
AGGREGATE_ALLsuma los recuentos de trabajos de todas las cuentas de la organización autenticada y, a continuación, devuelve la suma.Patrón:
^[0-9]{12}$ - AggregationPeriod
-
El período de los resultados devueltos.
-
ONE_DAY: el recuento de trabajos diarios de los 14 días anteriores. -
SEVEN_DAYS: el recuento total de trabajos de los 7 días anteriores. -
FOURTEEN_DAYS: el recuento total de trabajos de los 14 días anteriores.
Valores válidos:
ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS -
- MaxResults
-
Este parámetro establece el número máximo de elementos que se van a devolver.
El valor es un entero. El rango de valores aceptados está entre 1 y 500.
Rango válido: valor mínimo de 1. Valor máximo de 1000.
- MessageCategory
-
Este parámetro devuelve el recuento de trabajos de la categoría de mensajes especificada.
Ejemplos de cadenas aceptadas son
AccessDenied,SuccessyInvalidParameters. Consulte en Monitorización una lista de cadenas de MessageCategory aceptadas.El valor ANY devuelve el recuento de todas las categorías de mensajes.
AGGREGATE_ALLsuma los recuentos de trabajos de todas las categorías de mensajes y devuelve la suma. - NextToken
-
El siguiente elemento que sigue a una lista parcial de recursos devueltos. Por ejemplo, si se solicita que se devuelva el número de recursos
MaxResults,NextTokenpermite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token. - ResourceType
-
Devuelve el recuento de trabajos del tipo de recurso especificado. Utilice
GetSupportedResourceTypesde solicitud para obtener cadenas para los tipos de recursos compatibles.El valor ANY devuelve el recuento de todos los tipos de recursos.
AGGREGATE_ALLsuma los recuentos de trabajos de todos los tipos de recursos y devuelve la suma.El tipo de recurso de AWS del que se va a hacer la copia de seguridad; por ejemplo, un volumen de Amazon Elastic Block Store (Amazon EBS) o una base de datos de Amazon Relational Database Service (Amazon RDS).
Patrón:
^[a-zA-Z0-9\-\_\.]{1,50}$ - State
-
Este parámetro devuelve el recuento de los trabajos con el estado especificado.
El valor ANY devuelve el recuento de todos los estados.
AGGREGATE_ALLsuma los recuentos de trabajos de todos los tipos de estados y devuelve la suma.Valores válidos:
CREATED | RUNNING | ABORTING | ABORTED | COMPLETING | COMPLETED | FAILING | FAILED | PARTIAL | AGGREGATE_ALL | ANY
Cuerpo de la solicitud
La solicitud no tiene un cuerpo de la solicitud.
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"AggregationPeriod": "string",
"CopyJobSummaries": [
{
"AccountId": "string",
"Count": number,
"EndTime": number,
"MessageCategory": "string",
"Region": "string",
"ResourceType": "string",
"StartTime": number,
"State": "string"
}
],
"NextToken": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- AggregationPeriod
-
El período de los resultados devueltos.
-
ONE_DAY: el recuento de trabajos diarios de los 14 días anteriores. -
SEVEN_DAYS: el recuento total de trabajos de los 7 días anteriores. -
FOURTEEN_DAYS: el recuento total de trabajos de los 14 días anteriores.
Tipo: cadena
-
- CopyJobSummaries
-
Devuelve un resumen que contiene Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime y Count de los trabajos incluidos.
Tipo: matriz de objetos CopyJobSummary
- NextToken
-
El siguiente elemento que sigue a una lista parcial de recursos devueltos. Por ejemplo, si se solicita que se devuelva el número de recursos
MaxResults,NextTokenpermite devolver más elementos de la lista empezando por la ubicación indicada por el siguiente token.Tipo: cadena
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterValueException
-
Indica que hay algún problema con el valor de un parámetro. Por ejemplo, el valor está fuera del rango.
Código de estado HTTP: 400
- ServiceUnavailableException
-
La solicitud no se ha ejecutado correctamente debido a un error temporal del servidor.
Código de estado HTTP: 500
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
