Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
GetGovCloudAccountInformation
Recupera información sobre la GovCloud cuenta vinculada a la cuenta estándar especificada (si existe), incluidos el ID y el estado de la GovCloud cuenta. Para usar esta API, un rol o usuario de IAM deben tener el permiso de account:GetGovCloudAccountInformation IAM.
Sintaxis de la solicitud
POST /getGovCloudAccountInformation HTTP/1.1
Content-type: application/json
{
"StandardAccountId": "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.
- StandardAccountId
-
Especifica el número de ID de cuenta de 12 dígitos de la AWS cuenta a la que desea acceder o modificar con esta operación.
Si no especifica este parámetro, el valor predeterminado será la AWS cuenta 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, y 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 administración de cuentas y, de manera opcional, puede 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 al no 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 y 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}Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"AccountState": "string",
"GovCloudAccountId": "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.
- AccountState
-
El estado de la GovCloud cuenta vinculada.
Tipo: cadena
Valores válidos:
PENDING_ACTIVATION | ACTIVE | SUSPENDED | CLOSED - GovCloudAccountId
-
El número de identificación de cuenta de 12 dígitos de la GovCloud cuenta vinculada.
Tipo: cadena
Patrón:
\d{12}
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AccessDeniedException
-
Se ha producido un error en la operación porque la identidad que ha realizado la llamada no tiene los permisos mínimos necesarios.
- errorType
-
El valor que API Gateway rellena en el encabezado de respuesta de
x-amzn-ErrorType.
Código de estado HTTP: 403
- InternalServerException
-
La operación falló debido a un error interno de AWS. Intente realizar la operación otra vez más tarde.
- errorType
-
El valor que API Gateway rellena en el encabezado de respuesta de
x-amzn-ErrorType.
Código de estado HTTP: 500
- ResourceNotFoundException
-
Se ha producido un error en la operación porque se ha especificado un recurso que no se encuentra.
- errorType
-
El valor que API Gateway rellena en el encabezado de respuesta de
x-amzn-ErrorType.
Código de estado HTTP: 404
- ResourceUnavailableException
-
Se produjo un error en la operación porque especificó un recurso que no está disponible actualmente.
- errorType
-
El valor que API Gateway rellena en el encabezado de respuesta de
x-amzn-ErrorType.
Código de estado HTTP: 424
- TooManyRequestsException
-
Se ha producido un error en la operación porque se la ha llamado con demasiada frecuencia y ha superado la limitación.
- errorType
-
El valor que API Gateway rellena en el encabezado de respuesta de
x-amzn-ErrorType.
Código de estado HTTP: 429
- ValidationException
-
Se ha producido un error en la operación porque uno de los parámetros de entrada no era válido.
- fieldList
-
El campo en el que se detectó la entrada no válida.
- message
-
El mensaje donde se le informa qué no era válido en la solicitud.
- reason
-
El motivo por el que se produjo un error en la validación.
Código de estado HTTP: 400
Ejemplos
Ejemplo 1
En el siguiente ejemplo, se recupera la información de la GovCloud cuenta vinculada cuyas credenciales se utilizan para llamar a la operación.
Solicitud de muestra
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{}Respuesta de ejemplo
HTTP/1.1 200 OK
Content-Type: application/json
{
"GovCloudAccountId": "123456789012",
"AccountState": "ACTIVE"
}Ejemplo 2
El siguiente ejemplo recupera la información de la GovCloud cuenta vinculada de la cuenta de miembro especificada en una organización. Debe usar las credenciales de la cuenta de administración de la organización o de la cuenta de administrador delegado del servicio de Account Management.
Solicitud de muestra
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{
"StandardAccountId": "111111111111"
}Respuesta de ejemplo
HTTP/1.1 200 OK
Content-Type: application/json
{
"GovCloudAccountId": "123456789012",
"AccountState": "ACTIVE"
}Ejemplo 3
En el siguiente ejemplo, se intenta recuperar la información de la GovCloud cuenta vinculada de una cuenta estándar que no está vinculada a ninguna GovCloud cuenta.
Solicitud de muestra
POST / HTTP/1.1
X-Amz-Target: AWSAccountV20210201.GetGovCloudAccountInformation
{
"StandardAccountId": "222222222222"
}Respuesta de ejemplo
HTTP/1.1 404
Content-Type: application/json
{
"message":"GovCloud Account ID not found for Standard Account - 222222222222."
}Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
