ListRegions
Muestra todas las regiones de una cuenta determinada y sus respectivos estados de suscripción. Opcionalmente, esta lista se puede filtrar por el parámetro region-opt-status-contains
.
Sintaxis de la solicitud
POST /listRegions HTTP/1.1
Content-type: application/json
{
"AccountId": "string
",
"MaxResults": number
,
"NextToken": "string
",
"RegionOptStatusContains": [ "string
" ]
}
Parámetros de solicitud del URI
La solicitud no utiliza ningún parámetro de URI.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- AccountId
-
Especifica el número de ID de 12 dígitos de la Cuenta de AWS a la que desea acceder o la que desea modificar con esta operación. Si no especifica este parámetro, el valor predeterminado será la cuenta de Amazon Web Services de la identidad utilizada para llamar a la operación. Para usar este parámetro, la persona que llama debe ser una identidad de la cuenta de administración de la organización o una cuenta de administrador delegado. El ID de cuenta especificado debe ser una cuenta de miembro en la misma organización. La organización debe tener todas las características habilitadas, así como el acceso de confianza habilitado para el servicio de Account Management y, de manera opcional, debe tener asignada una cuenta de administrador delegado.
nota
La cuenta de administración no puede especificar su propio
AccountId
. Debe llamar a la operación en un contexto independiente sin incluir el parámetroAccountId
.Para llamar a esta operación en una cuenta que no es miembro de una organización, no especifique este parámetro. En su lugar, llame a la operación con una identidad que pertenezca a la cuenta cuyos contactos desea recuperar o modificar.
Tipo: cadena
Patrón:
^\d{12}$
Requerido: no
- MaxResults
-
El número total de elementos que se devuelven en la salida del comando. Si el número total de elementos disponible es mayor que el valor especificado, se proporciona un
NextToken
en la salida del comando. Para reanudar la paginación, proporcione el valor deNextToken
en el argumentostarting-token
de un comando posterior. No utilice el elemento de respuestaNextToken
directamente fuera de la CLI de AWS. Para ver ejemplos de uso, consulte Pagination en la Guía del usuario de la interfaz de línea de comandos de AWS.Tipo: entero
Rango válido: valor mínimo de 1. Valor máximo de 50.
Requerido: no
- NextToken
-
Un token destinado a especificar dónde iniciar la paginación. Es el
NextToken
de una respuesta truncada anteriormente. Para ver ejemplos de uso, consulte Pagination en la Guía del usuario de la interfaz de línea de comandos de AWS.Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 1000 caracteres.
Requerido: no
- RegionOptStatusContains
-
Una lista de estados de región (habilitando, habilitada, deshabilitando, deshabilitada, habilitada por defecto) que se puede usar para filtrar la lista de regiones de una cuenta determinada. Por ejemplo, si se introduce un valor de HABILITANDO, solo se mostrará una lista de regiones con el estado de HABILITANDO.
Tipo: matriz de cadenas
Valores válidos:
ENABLED | ENABLING | DISABLING | DISABLED | ENABLED_BY_DEFAULT
Requerido: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Regions": [
{
"RegionName": "string",
"RegionOptStatus": "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.
- NextToken
-
Si hay más datos que devolver, se rellenarán. Debe pasarse al parámetro de solicitud
next-token
delist-regions
.Tipo: cadena
- Regions
-
Esta es una lista de regiones para una cuenta determinada o, si se utilizó el parámetro filtrado, una lista de regiones que coinciden con los criterios de filtro establecidos en el parámetro
filter
.Tipo: matriz de objetos Region
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AccessDeniedException
-
Se produjo un error en la operación porque la identidad que realiza la llamada no tiene los permisos mínimos necesarios.
Código de estado HTTP: 403
- InternalServerException
-
Se produjo un error en la operación debido a un error interno de AWS. Intente operar otra vez más tarde.
Código de estado HTTP: 500
- TooManyRequestsException
-
Se produjo un error en la operación porque se realizó la llamada con demasiada frecuencia y superó la limitación.
Código de estado HTTP: 429
- ValidationException
-
Se produjo un error en la operación porque uno de los parámetros de entrada no era válido.
Código de estado HTTP: 400
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: