Esta documentação é somente para a versão 1 da AWS CLI. Para obter a documentação relacionada à AWS CLI versão 2, consulte o Guia do usuário da versão 2.
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o Organizations.
Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
Tópicos
Ações
O código de exemplo a seguir mostra como usar accept-handshake
.
- AWS CLI
-
Como aceitar um handshake de outra conta
Bill, proprietário de uma organização, já havia convidado a conta de Juan para se juntar à sua organização. O exemplo a seguir mostra a conta de Juan aceitando o handshake e, assim, concordando com o convite.
aws organizations accept-handshake --handshake-id
h-examplehandshakeid111
A saída mostra o seguinte:
{ "Handshake": { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "RequestedTimestamp": 1481656459.257, "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "ALL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" } ], "State": "ACCEPTED" } }
-
Para ver detalhes da API, consulte AcceptHandshake
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar attach-policy
.
- AWS CLI
-
Como anexar uma política a uma raiz, unidade operacional ou conta
Exemplo 1
O seguinte exemplo mostra com anexar uma política de controle de serviços (SCP) a uma unidade operacional (OU):
aws organizations attach-policy --policy-id
p-examplepolicyid111
--target-idou-examplerootid111-exampleouid111
Exemplo 2
O seguinte exemplo mostra como anexar uma política de controle de serviços a uma conta:
aws organizations attach-policy --policy-id
p-examplepolicyid111
--target-id333333333333
-
Para obter detalhes da API, consulte AttachPolicy
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar cancel-handshake
.
- AWS CLI
-
Como cancelar um handshake enviado de outra conta
Bill já havia enviado um convite para que a conta de Susan se junte à sua organização. Ele muda de ideia e decide cancelar o convite antes que Susan o aceite. O exemplo a seguir mostra o cancelamento de Bill:
aws organizations cancel-handshake --handshake-id
h-examplehandshakeid111
A saída inclui um objeto de handshake que mostra que o status agora é
CANCELED
:{ "Handshake": { "Id": "h-examplehandshakeid111", "State":"CANCELED", "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "susan@example.com", "Type": "EMAIL" } ], "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid", "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@example.com" }, { "Type": "MASTER_NAME", "Value": "Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "CONSOLIDATED_BILLING" } ] }, { "Type": "EMAIL", "Value": "anika@example.com" }, { "Type": "NOTES", "Value": "This is a request for Susan's account to join Bob's organization." } ], "RequestedTimestamp": 1.47008383521E9, "ExpirationTimestamp": 1.47137983521E9 } }
-
Para ver detalhes da API, consulte CancelHandshake
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar create-account
.
- AWS CLI
-
Como criar uma conta de membro que automaticamente faça parte da organização
O exemplo a seguir mostra como criar uma conta de membro em uma organização. A conta de membro é configurada com o nome Production Account e o endereço de e-mail susan@example.com. O Organizations automaticamente cria um perfil do IAM usando o nome padrão OrganizationAccountAccessRole porque o parâmetro roleName não foi especificado. Além disso, a configuração que permite que perfis ou usuários do IAM com permissões suficientes acessem os dados de faturamento da conta é definida com o valor padrão de ALLOW porque o parâmetro IamUserAccessToBilling não foi especificado. O Organizations automaticamente envia um e-mail de “Boas-vindas à AWS” para Susan:
aws organizations create-account --email
susan@example.com
--account-name"Production Account"
A saída inclui um objeto de solicitação que mostra que o status agora é
IN_PROGRESS
:{ "CreateAccountStatus": { "State": "IN_PROGRESS", "Id": "car-examplecreateaccountrequestid111" } }
Você pode consultar o status atual da solicitação posteriormente. Para fazer isso, forneça o valor de resposta do ID ao comando describe-create-account-status como o valor do parâmetro create-account-request-id.
Para obter informações, consulte Creating an AWS Account in Your Organization no Guia do usuário do AWS Organizations.
-
Para obter detalhes da API, consulte CreateAccount
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar create-organization
.
- AWS CLI
-
Exemplo 1: como criar uma organização
Bill quer criar uma organização usando as credenciais da conta 111111111111. O exemplo a seguir mostra que a conta se torna a conta principal na nova organização. Como ele não especificou um conjunto de recursos, a nova organização usa como padrão todos os recursos habilitados e as políticas de controle de serviços são habilitadas na raiz.
aws organizations create-organization
A saída inclui um objeto de organização com detalhes sobre a nova organização:
{ "Organization": { "AvailablePolicyTypes": [ { "Status": "ENABLED", "Type": "SERVICE_CONTROL_POLICY" } ], "MasterAccountId": "111111111111", "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "FeatureSet": "ALL", "Id": "o-exampleorgid", "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid" } }
Exemplo 2: como criar uma organização apenas com os recursos de faturamento consolidados
O seguinte exemplo cria uma organização compatível apenas com os recursos de faturamento consolidados:
aws organizations create-organization --feature-set
CONSOLIDATED_BILLING
A saída inclui um objeto de organização com detalhes sobre a nova organização:
{ "Organization": { "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", "AvailablePolicyTypes": [], "Id": "o-exampleorgid", "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "MasterAccountId": "111111111111", "FeatureSet": "CONSOLIDATED_BILLING" } }
Para obter informações, consulte Criar uma organização no Guia do usuário do AWS Organizations.
-
Para obter detalhes da API, consulte CreateOrganization
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar create-organizational-unit
.
- AWS CLI
-
Como criar uma unidade organizacional em uma unidade organizacional raiz ou pai
O seguinte exemplo mostra como criar uma UO chamada AccountingOU:
aws organizations create-organizational-unit --parent-id
r-examplerootid111
--nameAccountingOU
A saída inclui um objeto organizationalUnit que contém detalhes sobre a nova UO:
{ "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Name": "AccountingOU" } }
-
Para obter detalhes da API, consulte CreateOrganizationalUnit
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar create-policy
.
- AWS CLI
-
Exemplo 1: como criar uma política com um arquivo de origem de texto na política JSON
O exemplo a seguir mostra como criar uma política de controle de serviço (SCP) chamada
AllowAllS3Actions
. O conteúdo da política provém de um arquivo chamadopolicy.json
presente no computador local.aws organizations create-policy --content
file://policy.json
--nameAllowAllS3Actions,
--typeSERVICE_CONTROL_POLICY
--description"Allows delegation of all S3 actions"
A saída inclui um objeto de política com detalhes sobre a nova política:
{ "Policy": { "Content": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}", "PolicySummary": { "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid111", "Description": "Allows delegation of all S3 actions", "Name": "AllowAllS3Actions", "Type":"SERVICE_CONTROL_POLICY" } } }
Exemplo 2: como criar uma política tendo uma política JSON como parâmetro
O exemplo a seguir mostra como criar a mesma SCP, mas, desta vez, incorporando o conteúdo da política como uma string JSON no parâmetro. A string deve ser recuada com barras invertidas antes das aspas duplas para garantir que ela seja tratada como literal no parâmetro (que está entre aspas duplas):
aws organizations create-policy --content "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}" --name
AllowAllS3Actions
--typeSERVICE_CONTROL_POLICY
--description"Allows delegation of all S3 actions"
Para obter mais informações sobre como criar e usar políticas em sua organização, consulte Gerenciamento de políticas organizacionais no Guia do usuário do AWS Organizations.
-
Para obter detalhes da API, consulte CreatePolicy
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar decline-handshake
.
- AWS CLI
-
Como recusar um handshake enviado de outra conta
O exemplo a seguir mostra que Susan, uma administradora proprietária da conta 222222222222, recusa um convite para se juntar à organização de Bill. A operação DeclineHandshake retorna um objeto de handshake, mostrando que o estado agora é DECLINADO:
aws organizations decline-handshake --handshake-id
h-examplehandshakeid111
A saída inclui um objeto de handshake que mostra o novo estado de
DECLINED
:{ "Handshake": { "Id": "h-examplehandshakeid111", "State": "DECLINED", "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid", "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@example.com" }, { "Type": "MASTER_NAME", "Value": "Master Account" } ] }, { "Type": "EMAIL", "Value": "susan@example.com" }, { "Type": "NOTES", "Value": "This is an invitation to Susan's account to join the Bill's organization." } ], "Parties": [ { "Type": "EMAIL", "Id": "susan@example.com" }, { "Type": "ORGANIZATION", "Id": "o-exampleorgid" } ], "Action": "INVITE", "RequestedTimestamp": 1470684478.687, "ExpirationTimestamp": 1471980478.687, "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" } }
-
Para ver detalhes da API, consulte DeclineHandshake
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-organization
.
- AWS CLI
-
Como excluir uma organização
O exemplo a seguir mostra como excluir uma organização. Você deve ser administrador da conta principal na organização para poder realizar essa operação. O exemplo pressupõe que você já removeu todas as contas de membro, UOs e políticas da organização:
aws organizations delete-organization
-
Para obter detalhes da API, consulte DeleteOrganization
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-organizational-unit
.
- AWS CLI
-
Como excluir uma UO
O exemplo a seguir mostra como excluir uma UO. O exemplo pressupõe que você já removeu todas as contas e outras UOs da UO:
aws organizations delete-organizational-unit --organizational-unit-id
ou-examplerootid111-exampleouid111
-
Para obter detalhes da API, consulte DeleteOrganizationalUnit
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar delete-policy
.
- AWS CLI
-
Como excluir uma política
O exemplo a seguir mostra como excluir uma política de uma organização. O exemplo pressupõe que você já separou a política de todas as entidades:
aws organizations delete-policy --policy-id
p-examplepolicyid111
-
Para obter detalhes da API, consulte DeletePolicy
na Referência de comandos AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-account
.
- AWS CLI
-
Para obter os detalhes sobre uma conta
O exemplo a seguir mostra como solicitar os detalhes sobre uma conta:
aws organizations describe-account --account-id
555555555555
A saída mostra um objeto de conta com os detalhes da conta:
{ "Account": { "Id": "555555555555", "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", "Name": "Beta account", "Email": "anika@example.com", "JoinedMethod": "INVITED", "JoinedTimeStamp": 1481756563.134, "Status": "ACTIVE" } }
-
Para ver detalhes da API, consulte DescribeAccount
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-create-account-status
.
- AWS CLI
-
Para obter o status mais recente de uma solicitação de criação de conta
O exemplo a seguir mostra como solicitar o status mais recente de uma solicitação anterior de criação de conta em uma organização. O --request-id especificado vem da resposta da chamada original de create-account. A solicitação de criação de conta mostra pelo campo de status que o Organizations concluiu com êxito a criação da conta.
Comando:
aws organizations describe-create-account-status --create-account-request-id
car-examplecreateaccountrequestid111
Saída:
{ "CreateAccountStatus": { "State": "SUCCEEDED", "AccountId": "555555555555", "AccountName": "Beta account", "RequestedTimestamp": 1470684478.687, "CompletedTimestamp": 1470684532.472, "Id": "car-examplecreateaccountrequestid111" } }
-
Para ver detalhes da API, consulte DescribeCreateAccountStatus
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-handshake
.
- AWS CLI
-
Para obter mais informações sobre um handshake
O exemplo a seguir mostra como solicitar detalhes sobre um handshake. O ID do handshake vem da chamada original de
InviteAccountToOrganization
, ou de uma chamada deListHandshakesForAccount
ouListHandshakesForOrganization
:aws organizations describe-handshake --handshake-id
h-examplehandshakeid111
A saída inclui um objeto de handshake que tem todos os detalhes sobre o handshake solicitado:
{ "Handshake": { "Id": "h-examplehandshakeid111", "State": "OPEN", "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid", "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@example.com" }, { "Type": "MASTER_NAME", "Value": "Master Account" } ] }, { "Type": "EMAIL", "Value": "anika@example.com" } ], "Parties": [ { "Type": "ORGANIZATION", "Id": "o-exampleorgid" }, { "Type": "EMAIL", "Id": "anika@example.com" } ], "Action": "INVITE", "RequestedTimestamp": 1470158698.046, "ExpirationTimestamp": 1471454698.046, "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" } }
-
Para ver detalhes da API, consulte DescribeHandshake
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-organization
.
- AWS CLI
-
Para obter informações sobre a organização atual
O exemplo a seguir mostra como solicitar os detalhes sobre uma organização:
aws organizations describe-organization
A saída inclui um objeto de organização que contém os detalhes sobre a organização:
{ "Organization": { "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "MasterAccountId": "111111111111", "Id": "o-exampleorgid", "FeatureSet": "ALL", "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", "AvailablePolicyTypes": [ { "Status": "ENABLED", "Type": "SERVICE_CONTROL_POLICY" } ] } }
-
Para ver detalhes da API, consulte DescribeOrganization
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-organizational-unit
.
- AWS CLI
-
Para obter informações sobre uma OU
O exemplo
describe-organizational-unit
a seguir solicita detalhes sobre uma OU.aws organizations describe-organizational-unit \ --organizational-unit-id
ou-examplerootid111-exampleouid111
Saída:
{ "OrganizationalUnit": { "Name": "Accounting Group", "Arn": "arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Id": "ou-examplerootid111-exampleouid111" } }
-
Para ver detalhes da API, consulte DescribeOrganizationalUnit
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar describe-policy
.
- AWS CLI
-
Como obter informações sobre uma política
O seguinte exemplo mostra como solicitar informações sobre uma política:
aws organizations describe-policy --policy-id
p-examplepolicyid111
A saída inclui um objeto de política que contém detalhes sobre a política:
{ "Policy": { "Content": "{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}", "PolicySummary": { "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", "Type": "SERVICE_CONTROL_POLICY", "Id": "p-examplepolicyid111", "AwsManaged": false, "Name": "AllowAllS3Actions", "Description": "Enables admins to delegate S3 permissions" } } }
-
Para obter detalhes da API, consulte DescribePolicy
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar detach-policy
.
- AWS CLI
-
Como separar uma política de uma raiz, UO ou conta
O seguinte exemplo mostra como separar uma política de uma UO:
aws organizations detach-policy --target-id
ou-examplerootid111-exampleouid111
--policy-idp-examplepolicyid111
-
Para obter detalhes da API, consulte.DetachPolicy
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar disable-policy-type
.
- AWS CLI
-
Para desativar um tipo de política em uma raiz
O exemplo a seguir mostra como desativar o tipo de política de controle de serviços (SCP) em uma raiz:
aws organizations disable-policy-type --root-id
r-examplerootid111
--policy-typeSERVICE_CONTROL_POLICY
A saída mostra que o elemento de resposta PolicyTypes não inclui mais SERVICE_CONTROL_POLICY:
{ "Root": { "PolicyTypes": [], "Name": "Root", "Id": "r-examplerootid111", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } }
-
Para ver detalhes da API, consulte DisablePolicyType
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar enable-all-features
.
- AWS CLI
-
Como permitir todos os atributos em uma organização
Este exemplo mostra o administrador solicitando que todas as contas convidadas da organização aprovem todos os atributos habilitados na organização. AWS O Organizations envia um e-mail para o endereço registrado em cada conta de membro convidado, solicitando que o proprietário aprove a alteração em todos os atributos aceitando o handshake enviado. Depois que todas as contas de membros convidados aceitarem o handshake, o administrador da organização poderá finalizar a alteração em todos os atributos, e aqueles com as permissões apropriadas poderão criar políticas e aplicá-las às raízes, OUs e contas:
aws organizations enable-all-features
A saída é um objeto de handshake que é enviado para aprovação de todas as contas de membros convidados:
{ "Handshake": { "Action": "ENABLE_ALL_FEATURES", "Arn":"arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", "ExpirationTimestamp":1.483127868609E9, "Id":"h-examplehandshakeid111", "Parties": [ { "id":"o-exampleorgid", "type":"ORGANIZATION" } ], "requestedTimestamp":1.481831868609E9, "resources": [ { "type":"ORGANIZATION", "value":"o-exampleorgid" } ], "state":"REQUESTED" } }
-
Para ver detalhes da API, consulte EnableAllFeatures
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar enable-policy-type
.
- AWS CLI
-
Como ativar o uso de um tipo de política em uma raiz
O exemplo a seguir mostra como ativar o tipo de política de controle de serviços (SCP) em uma raiz:
aws organizations enable-policy-type --root-id
r-examplerootid111
--policy-typeSERVICE_CONTROL_POLICY
A saída mostra um objeto raiz com um elemento de resposta policyTypes mostrando que os SCPs agora estão ativados:
{ "Root": { "PolicyTypes": [ { "Status":"ENABLED", "Type":"SERVICE_CONTROL_POLICY" } ], "Id": "r-examplerootid111", "Name": "Root", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } }
-
Para ver detalhes da API, consulte EnablePolicyType
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar invite-account-to-organization
.
- AWS CLI
-
Como convidar uma conta para se juntar a uma organização
O exemplo a seguir mostra a conta principal de propriedade de bill@example.com convidando a conta de propriedade de juan@example.com para se juntar a uma organização:
aws organizations invite-account-to-organization --target '
{"Type": "EMAIL", "Id": "juan@example.com"}
' --notes"This is a request for Juan's account to join Bill's organization."
A saída inclui uma estrutura de handshake que mostra o que é enviado para a conta convidada:
{ "Handshake": { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1481656459.257, "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "FULL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" } ], "State": "OPEN" } }
-
Para ver detalhes da API, consulte InviteAccountToOrganization
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar leave-organization
.
- AWS CLI
-
Como sair de uma organização como uma conta-membro
O exemplo a seguir mostra o administrador de uma conta de membro solicitando saída da organização da qual é membro atualmente:
aws organizations leave-organization
-
Para ver detalhes da API, consulte LeaveOrganization
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-accounts-for-parent
.
- AWS CLI
-
Para recuperar uma lista de todas as contas em uma raiz principal ou OU especificada
O exemplo a seguir mostra como solicitar uma lista das contas de uma OU:
aws organizations list-accounts-for-parent --parent-id
ou-examplerootid111-exampleouid111
A saída inclui uma lista de objetos de resumo da conta.
{ "Accounts": [ { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835795.536, "Id": "333333333333", "Name": "Development Account", "Email": "juan@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835812.143, "Id": "444444444444", "Name": "Test Account", "Email": "anika@example.com", "Status": "ACTIVE" } ] }
-
Para ver detalhes da API, consulte ListAccountsForParent
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-accounts
.
- AWS CLI
-
Para recuperar uma lista de todas as contas de uma organização
O seguinte exemplo mostra como solicitar uma lista das contas de uma organização:
aws organizations list-accounts
A saída inclui uma lista de objetos de resumo da conta.
{ "Accounts": [ { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481830215.45, "Id": "111111111111", "Name": "Master Account", "Email": "bill@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835741.044, "Id": "222222222222", "Name": "Production Account", "Email": "alice@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835795.536, "Id": "333333333333", "Name": "Development Account", "Email": "juan@example.com", "Status": "ACTIVE" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", "JoinedMethod": "INVITED", "JoinedTimestamp": 1481835812.143, "Id": "444444444444", "Name": "Test Account", "Email": "anika@example.com", "Status": "ACTIVE" } ] }
-
Para obter detalhes da API, consulte ListAccounts
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-children
.
- AWS CLI
-
Para recuperar as contas secundárias e OUs de uma OU principal ou raiz
O exemplo a seguir mostra como listar a raiz ou OU que contém a conta 444444444444:
aws organizations list-children --child-type
ORGANIZATIONAL_UNIT
--parent-idou-examplerootid111-exampleouid111
A saída mostra as duas OUs secundárias contidas pela principal:
{ "Children": [ { "Id": "ou-examplerootid111-exampleouid111", "Type":"ORGANIZATIONAL_UNIT" }, { "Id":"ou-examplerootid111-exampleouid222", "Type":"ORGANIZATIONAL_UNIT" } ] }
-
Para ver detalhes da API, consulte ListChildren
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-create-account-status
.
- AWS CLI
-
Exemplo 1: recuperar uma lista das solicitações de criação de conta feitas na organização atual
O exemplo a seguir mostra como solicitar uma lista de solicitações de criação de conta de uma organização que foram concluídas com êxito:
aws organizations list-create-account-status --states
SUCCEEDED
A saída inclui uma matriz de objetos com informações sobre cada solicitação.
{ "CreateAccountStatuses": [ { "AccountId": "444444444444", "AccountName": "Developer Test Account", "CompletedTimeStamp": 1481835812.143, "Id": "car-examplecreateaccountrequestid111", "RequestedTimeStamp": 1481829432.531, "State": "SUCCEEDED" } ] }
Exemplo 2: recuperar uma lista das solicitações de criação de conta em andamento feitas na organização atual
O exemplo a seguir obtém uma lista de solicitações de criação de conta em andamento para uma organização:
aws organizations list-create-account-status --states
IN_PROGRESS
A saída inclui uma matriz de objetos com informações sobre cada solicitação.
{ "CreateAccountStatuses": [ { "State": "IN_PROGRESS", "Id": "car-examplecreateaccountrequestid111", "RequestedTimeStamp": 1481829432.531, "AccountName": "Production Account" } ] }
-
Para ver detalhes da API, consulte ListCreateAccountStatus
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-handshakes-for-account
.
- AWS CLI
-
Para recuperar uma lista dos handshakes enviados para uma conta
O exemplo a seguir mostra como obter uma lista de todos os handshakes associados à conta das credenciais que foram usadas para chamar a operação:
aws organizations list-handshakes-for-account
A saída inclui uma lista de estruturas de handshake com informações sobre cada handshake, incluindo seu estado atual:
{ "Handshake": { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1481656459.257, "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "FULL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" } ], "State": "OPEN" } }
-
Para ver detalhes da API, consulte ListHandshakesForAccount
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-handshakes-for-organization
.
- AWS CLI
-
Para recuperar uma lista dos handshakes associados a uma organização
O exemplo a seguir mostra como obter uma lista dos handshakes associados à organização atual:
aws organizations list-handshakes-for-organization
A saída mostra dois handshakes. O primeiro é um convite para a conta de Juan e mostra o estado de OPEN. O segundo é um convite para a conta de Anika e mostra o estado ACEITO:
{ "Handshakes": [ { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1482952459.257, "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1481656459.257, "Resources": [ { "Resources": [ { "Type": "MASTER_EMAIL", "Value": "bill@amazon.com" }, { "Type": "MASTER_NAME", "Value": "Org Master Account" }, { "Type": "ORGANIZATION_FEATURE_SET", "Value": "FULL" } ], "Type": "ORGANIZATION", "Value": "o-exampleorgid" }, { "Type": "EMAIL", "Value": "juan@example.com" }, { "Type":"NOTES", "Value":"This is an invitation to Juan's account to join Bill's organization." } ], "State": "OPEN" }, { "Action": "INVITE", "State":"ACCEPTED", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": 1.471797437427E9, "Id": "h-examplehandshakeid222", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "anika@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": 1.469205437427E9, "Resources": [ { "Resources": [ { "Type":"MASTER_EMAIL", "Value":"bill@example.com" }, { "Type":"MASTER_NAME", "Value":"Master Account" } ], "Type":"ORGANIZATION", "Value":"o-exampleorgid" }, { "Type":"EMAIL", "Value":"anika@example.com" }, { "Type":"NOTES", "Value":"This is an invitation to Anika's account to join Bill's organization." } ] } ] }
-
Para ver detalhes da API, consulte ListHandshakesForOrganization
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-organizational-units-for-parent
.
- AWS CLI
-
Para recuperar uma lista das OUs em uma OU principal ou raiz
O exemplo a seguir mostra como obter uma lista de OUs em uma raiz especificada:
aws organizations list-organizational-units-for-parent --parent-id
r-examplerootid111
A saída mostra que a raiz especificada contém duas OUs e mostra os detalhes de cada uma:
{ "OrganizationalUnits": [ { "Name": "AccountingDepartment", "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid111" }, { "Name": "ProductionDepartment", "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid222" } ] }
-
Para ver detalhes da API, consulte ListOrganizationalUnitsForParent
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-parents
.
- AWS CLI
-
Para listar as OUs principais ou raízes de uma conta ou OU secundária
O exemplo a seguir mostra como listar a raiz ou OU principal que contém a conta 444444444444:
aws organizations list-parents --child-id
444444444444
A saída mostra que a conta especificada está na OU com o ID especificado:
{ "Parents": [ { "Id": "ou-examplerootid111-exampleouid111", "Type": "ORGANIZATIONAL_UNIT" } ] }
-
Para ver detalhes da API, consulte ListParents
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-policies-for-target
.
- AWS CLI
-
Para recuperar uma lista dos SCPs anexados diretamente a uma conta
O exemplo a seguir mostra como obter uma lista de todas as políticas de controle de serviços (SCPs), conforme especificado pelo parâmetro Filter, que estão diretamente anexadas a uma conta:
aws organizations list-policies-for-target --filter
SERVICE_CONTROL_POLICY
--target-id444444444444
A saída inclui uma lista de estruturas de políticas com informações resumidas. A lista não inclui políticas que se aplicam à conta devido à herança de sua localização na hierarquia de uma OU:
{ "Policies": [ { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllEC2Actions", "AwsManaged", false, "Id": "p-examplepolicyid222", "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid222", "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." } ] }
-
Para ver detalhes da API, consulte ListPoliciesForTarget
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-policies
.
- AWS CLI
-
Para recuperar uma lista de todas as políticas de um determinado tipo de uma organização
O seguinte exemplo mostra como obter uma lista de SCPs, conforme especificado pelo parâmetro do filtro:
aws organizations list-policies --filter
SERVICE_CONTROL_POLICY
A saída inclui uma lista de políticas com informações resumidas:
{ "Policies": [ { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllS3Actions", "AwsManaged": false, "Id": "p-examplepolicyid111", "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid111", "Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts." }, { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllEC2Actions", "AwsManaged": false, "Id": "p-examplepolicyid222", "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid222", "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." }, { "AwsManaged": true, "Description": "Allows access to every operation", "Type": "SERVICE_CONTROL_POLICY", "Id": "p-FullAWSAccess", "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess", "Name": "FullAWSAccess" } ] }
-
Para obter detalhes da API, consulte ListPolicies
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-roots
.
- AWS CLI
-
Para recuperar uma lista de raízes em uma organização
Este exemplo mostra como obter a lista de raízes de uma organização:
aws organizations list-roots
A saída inclui uma lista de estruturas de raízes com informações resumidas:
{ "Roots": [ { "Name": "Root", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", "Id": "r-examplerootid111", "PolicyTypes": [ { "Status":"ENABLED", "Type":"SERVICE_CONTROL_POLICY" } ] } ] }
-
Para ver detalhes da API, consulte ListRoots
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar list-targets-for-policy
.
- AWS CLI
-
Para recuperar uma lista das raízes, OUs e contas às quais uma política está anexada
O exemplo a seguir mostra como obter uma lista de todas as raízes, OUs e contas às quais a política especificada está anexada:
aws organizations list-targets-for-policy --policy-id
p-FullAWSAccess
A saída inclui uma lista de objetos de anexos com informações resumidas sobre raízes, OUs e contas às quais a política está anexada:
{ "Targets": [ { "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", "Name": "Root", "TargetId":"r-examplerootid111", "Type":"ROOT" }, { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;", "Name": "Developer Test Account", "TargetId": "333333333333", "Type": "ACCOUNT" }, { "Arn":"arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Name":"Accounting", "TargetId":"ou-examplerootid111-exampleouid111", "Type":"ORGANIZATIONAL_UNIT" } ] }
-
Para ver detalhes da API, consulte ListTargetsForPolicy
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar move-account
.
- AWS CLI
-
Para mover uma conta entre raízes ou OUs
O exemplo a seguir mostra como mover a conta principal da organização da raiz para uma OU:
aws organizations move-account --account-id
333333333333
--source-parent-idr-examplerootid111
--destination-parent-idou-examplerootid111-exampleouid111
-
Para ver detalhes da API, consulte MoveAccount
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar remove-account-from-organization
.
- AWS CLI
-
Para remover uma conta de uma organização como conta principal
O exemplo a seguir mostra como remover uma conta de uma organização:
aws organizations remove-account-from-organization --account-id
333333333333
-
Para ver detalhes da API, consulte RemoveAccountFromOrganization
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar update-organizational-unit
.
- AWS CLI
-
Para renomear uma OU
Este exemplo mostra como renomear uma OU: neste exemplo, a OU é renomeada para "AccountingOU":
aws organizations update-organizational-unit --organizational-unit-id
ou-examplerootid111-exampleouid111
--nameAccountingOU
A saída mostra o novo nome:
{ "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111" "Name": "AccountingOU", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"" } }
-
Para ver detalhes da API, consulte UpdateOrganizationalUnit
na Referência de comandos da AWS CLI.
-
O código de exemplo a seguir mostra como usar update-policy
.
- AWS CLI
-
Exemplo 1: renomear uma política
O exemplo
update-policy
a seguir renomeia uma política e fornece uma nova descrição.aws organizations update-policy \ --policy-id
p-examplepolicyid111
\ --nameRenamed-Policy
\ --description"This description replaces the original."
A saída mostra o novo nome e descrição.
{ "Policy": { "Content": "{\n \"Version\":\"2012-10-17\",\n \"Statement\":{\n \"Effect\":\"Allow\",\n \"Action\":\"ec2:*\",\n \"Resource\":\"*\"\n }\n}\n", "PolicySummary": { "Id": "p-examplepolicyid111", "AwsManaged": false, "Arn":"arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", "Description": "This description replaces the original.", "Name": "Renamed-Policy", "Type": "SERVICE_CONTROL_POLICY" } } }
Exemplo 2: substituir o conteúdo de texto JSON de uma política
O exemplo a seguir mostra como substituir o texto JSON do SCP no exemplo anterior por uma nova string de texto de política JSON que permite S3 em vez de EC2:
aws organizations update-policy \ --policy-id
p-examplepolicyid111
\ --content "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}"A saída mostra o novo conteúdo:
{ "Policy": { "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }", "PolicySummary": { "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", "AwsManaged": false; "Description": "This description replaces the original.", "Id": "p-examplepolicyid111", "Name": "Renamed-Policy", "Type": "SERVICE_CONTROL_POLICY" } } }
-
Para ver detalhes da API, consulte UpdatePolicy
na Referência de comandos da AWS CLI.
-