{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.organizations#AWSOrganizationsNotInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Your account isn't a member of an organization. To make this request, you must use the\n credentials of an account that belongs to an organization.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#AWSOrganizationsV20161128": { "type": "service", "version": "2016-11-28", "operations": [ { "target": "com.amazonaws.organizations#AcceptHandshake" }, { "target": "com.amazonaws.organizations#AttachPolicy" }, { "target": "com.amazonaws.organizations#CancelHandshake" }, { "target": "com.amazonaws.organizations#CloseAccount" }, { "target": "com.amazonaws.organizations#CreateAccount" }, { "target": "com.amazonaws.organizations#CreateGovCloudAccount" }, { "target": "com.amazonaws.organizations#CreateOrganization" }, { "target": "com.amazonaws.organizations#CreateOrganizationalUnit" }, { "target": "com.amazonaws.organizations#CreatePolicy" }, { "target": "com.amazonaws.organizations#DeclineHandshake" }, { "target": "com.amazonaws.organizations#DeleteOrganization" }, { "target": "com.amazonaws.organizations#DeleteOrganizationalUnit" }, { "target": "com.amazonaws.organizations#DeletePolicy" }, { "target": "com.amazonaws.organizations#DeleteResourcePolicy" }, { "target": "com.amazonaws.organizations#DeregisterDelegatedAdministrator" }, { "target": "com.amazonaws.organizations#DescribeAccount" }, { "target": "com.amazonaws.organizations#DescribeCreateAccountStatus" }, { "target": "com.amazonaws.organizations#DescribeEffectivePolicy" }, { "target": "com.amazonaws.organizations#DescribeHandshake" }, { "target": "com.amazonaws.organizations#DescribeOrganization" }, { "target": "com.amazonaws.organizations#DescribeOrganizationalUnit" }, { "target": "com.amazonaws.organizations#DescribePolicy" }, { "target": "com.amazonaws.organizations#DescribeResourcePolicy" }, { "target": "com.amazonaws.organizations#DescribeResponsibilityTransfer" }, { "target": "com.amazonaws.organizations#DetachPolicy" }, { "target": "com.amazonaws.organizations#DisableAWSServiceAccess" }, { "target": "com.amazonaws.organizations#DisablePolicyType" }, { "target": "com.amazonaws.organizations#EnableAllFeatures" }, { "target": "com.amazonaws.organizations#EnableAWSServiceAccess" }, { "target": "com.amazonaws.organizations#EnablePolicyType" }, { "target": "com.amazonaws.organizations#InviteAccountToOrganization" }, { "target": "com.amazonaws.organizations#InviteOrganizationToTransferResponsibility" }, { "target": "com.amazonaws.organizations#LeaveOrganization" }, { "target": "com.amazonaws.organizations#ListAccounts" }, { "target": "com.amazonaws.organizations#ListAccountsForParent" }, { "target": "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicy" }, { "target": "com.amazonaws.organizations#ListAWSServiceAccessForOrganization" }, { "target": "com.amazonaws.organizations#ListChildren" }, { "target": "com.amazonaws.organizations#ListCreateAccountStatus" }, { "target": "com.amazonaws.organizations#ListDelegatedAdministrators" }, { "target": "com.amazonaws.organizations#ListDelegatedServicesForAccount" }, { "target": "com.amazonaws.organizations#ListEffectivePolicyValidationErrors" }, { "target": "com.amazonaws.organizations#ListHandshakesForAccount" }, { "target": "com.amazonaws.organizations#ListHandshakesForOrganization" }, { "target": "com.amazonaws.organizations#ListInboundResponsibilityTransfers" }, { "target": "com.amazonaws.organizations#ListOrganizationalUnitsForParent" }, { "target": "com.amazonaws.organizations#ListOutboundResponsibilityTransfers" }, { "target": "com.amazonaws.organizations#ListParents" }, { "target": "com.amazonaws.organizations#ListPolicies" }, { "target": "com.amazonaws.organizations#ListPoliciesForTarget" }, { "target": "com.amazonaws.organizations#ListRoots" }, { "target": "com.amazonaws.organizations#ListTagsForResource" }, { "target": "com.amazonaws.organizations#ListTargetsForPolicy" }, { "target": "com.amazonaws.organizations#MoveAccount" }, { "target": "com.amazonaws.organizations#PutResourcePolicy" }, { "target": "com.amazonaws.organizations#RegisterDelegatedAdministrator" }, { "target": "com.amazonaws.organizations#RemoveAccountFromOrganization" }, { "target": "com.amazonaws.organizations#TagResource" }, { "target": "com.amazonaws.organizations#TerminateResponsibilityTransfer" }, { "target": "com.amazonaws.organizations#UntagResource" }, { "target": "com.amazonaws.organizations#UpdateOrganizationalUnit" }, { "target": "com.amazonaws.organizations#UpdatePolicy" }, { "target": "com.amazonaws.organizations#UpdateResponsibilityTransfer" } ], "traits": { "aws.api#service": { "sdkId": "Organizations", "arnNamespace": "organizations", "cloudFormationName": "Organizations", "cloudTrailEventSource": "organizations.amazonaws.com", "endpointPrefix": "organizations" }, "aws.auth#sigv4": { "name": "organizations" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "

Organizations is a web service that enables you to consolidate your multiple\n Amazon Web Services accounts into an organization and centrally manage your\n accounts and their resources.

\n

This guide provides descriptions of the Organizations API. For more\n information about using this service, see the Organizations User Guide.

\n

\n API version\n

\n

This version of the Organizations API Reference documents the Organizations API version\n 2016-11-28.

\n \n

As an alternative to using the API directly, you can use one of the Amazon Web Services SDKs,\n which consist of libraries and sample code for various programming languages and\n platforms (Java, Ruby, .NET, iOS, Android, and more). The SDKs provide a convenient\n way to create programmatic access to Organizations. For example, the SDKs take care of\n cryptographically signing requests, managing errors, and retrying requests\n automatically. For more information about the Amazon Web Services SDKs, including how to download\n and install them, see Tools for Amazon Web\n Services.

\n
\n

We recommend that you use the Amazon Web Services SDKs to make programmatic API calls to Organizations.\n However, you also can use the Organizations Query API to make direct calls to the Organizations web\n service. To learn more about the Organizations Query API, see Calling the API by making HTTP Query\n requests in the Organizations User Guide. Organizations supports GET and\n POST requests for all actions. That is, the API doesn't require you to use GET for some\n actions and POST for others. However, GET requests are subject to the limitation size of\n a URL. Therefore, for operations that require larger sizes, use a POST request.

\n

\n Signing requests\n

\n

When you send HTTP requests to Amazon Web Services, sign the requests so that Amazon Web Services can identify\n who sent them. You sign requests with your Amazon Web Services access key, which consists of an access\n key ID and a secret access key. We strongly recommend that you don't create an access\n key for your root account. Anyone who has the access key for your root account has\n unrestricted access to all the resources in your account. Instead, create an access key\n for an IAM user that has administrative permissions. As another option, use Amazon Web Services\n Security Token Service (Amazon Web Services STS) to generate temporary security credentials, and use\n those credentials to sign requests.

\n

To sign requests, we recommend that you use Signature Version 4. If you\n have an existing application that uses Signature Version 2, you don't have to update it\n to use Signature Version 4. However, some operations now require Signature Version 4.\n The documentation for operations that require version 4 indicate this\n requirement.

\n

When you use the Command Line Interface (CLI) or one of the Amazon Web Services SDKs to make requests to\n Amazon Web Services, these tools automatically sign the requests for you with the access key that you\n specify when you configure the tools.

\n

In this release, each organization can have only one root.

\n

\n Support and feedback for Organizations\n

\n

We welcome your feedback. You can post your feedback and questions in the Organizations support\n forum. For more information about the Amazon Web Services Support forums, see Forums Help.

\n

\n Endpoint to call When using the CLI or the Amazon Web Services\n SDK\n

\n

For the current release of Organizations, specify the us-east-1 region\n for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of\n China. If calling from one of the Amazon Web Services Regions in China, then specify\n cn-northwest-1. You can do this in the CLI by using these parameters\n and commands:

\n \n

\n How examples are presented\n

\n

The JSON returned by the Organizations service as response to your requests arrives as a\n single long string without line breaks or formatting whitespace. The examples in this\n guide include both line breaks and whitespace to improve readability. When example input\n parameters also would result in long strings that would extend beyond the screen, we\n insert line breaks to enhance readability. Always submit the input as a single JSON text\n string.

\n

\n Recording API Requests\n

\n

Organizations supports CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected\n by CloudTrail, you can determine which requests the Organizations service received, who made the\n request and when, and so on. For more about Organizations and its support for CloudTrail, see\n Logging\n Organizations API calls with CloudTrail in the\n Organizations User Guide. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.

", "smithy.api#title": "AWS Organizations", "smithy.api#xmlNamespace": { "uri": "http://organizations.amazonaws.com/doc/2016-11-28/" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://organizations.us-gov-west-1.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://organizations.us-gov-west-1.api.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://organizations-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://organizations-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://organizations.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://organizations.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 15, "nodes": "/////wAAAAH/////AAAAAAAAAA4AAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEMAAAABwX14QoF9eELAAAABAAAAAsAAAAJAAAABQX14QQAAAAKAAAABgX14QgF9eEJAAAABQX14QUAAAAMAAAABgAAAA0F9eEHAAAABwX14QYF9eEHAAAAAwX14QEAAAAPAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://organizations.us-gov-west-1.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://organizations.us-gov-west-1.api.aws", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://organizations-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://organizations-fips.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://organizations.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://organizations.{PartitionResult#implicitGlobalRegion}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "{PartitionResult#implicitGlobalRegion}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://organizations-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://organizations-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://organizations.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-east-1" } ] }, "url": "https://organizations.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://organizations-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://organizations-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://organizations.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "cn-northwest-1" } ] }, "url": "https://organizations.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eusc-de-east-1" } ] }, "url": "https://organizations-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eusc-de-east-1" } ] }, "url": "https://organizations.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-iso-east-1" } ] }, "url": "https://organizations-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-iso-east-1" } ] }, "url": "https://organizations.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isob-east-1" } ] }, "url": "https://organizations-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isob-east-1" } ] }, "url": "https://organizations.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eu-isoe-west-1" } ] }, "url": "https://organizations-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "eu-isoe-west-1" } ] }, "url": "https://organizations.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isof-south-1" } ] }, "url": "https://organizations-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-isof-south-1" } ] }, "url": "https://organizations.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://organizations.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://organizations.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://organizations.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingRegion": "us-gov-west-1" } ] }, "url": "https://organizations.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.organizations#AcceptHandshake": { "type": "operation", "input": { "target": "com.amazonaws.organizations#AcceptHandshakeRequest" }, "output": { "target": "com.amazonaws.organizations#AcceptHandshakeResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccessDeniedForDependencyException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#HandshakeAlreadyInStateException" }, { "target": "com.amazonaws.organizations#HandshakeConstraintViolationException" }, { "target": "com.amazonaws.organizations#HandshakeNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidHandshakeTransitionException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#MasterCannotLeaveOrganizationException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Accepts a handshake by sending an ACCEPTED response to the sender. You\n can view accepted handshakes in API responses for 30 days before they are\n deleted.

\n

\n Only the management account can accept the following\n handshakes:

\n \n

For more information, see Enabling all features and Responding to a billing transfer invitation in the\n Organizations User Guide.

\n

\n Only a member account can accept the following\n handshakes:

\n \n

For more information, see Responding to invitations and Enabling all features in the Organizations User Guide.

\n

When a handshake is accepted, Organizations logs membership events in CloudTrail, available\n only in the management account's event history. If the account was standalone and joined\n a new organization, an AccountJoinedOrganization event is logged with\n joinedMethod:INVITED and joinedTime fields. If the account\n departed one organization and joined another, both an\n AccountDepartedOrganization event with departureMethod:LEFT\n and departureTime and an AccountJoinedOrganization event with\n joinedMethod:INVITED and joinedTime are logged in their\n respective management accounts.

\n

When a billing transfer (TRANSFER_RESPONSIBILITY) handshake is accepted,\n Organizations publishes a ResponsibilityTransferAccepted service event to CloudTrail.\n Each affected account receives this event, including upstream participants such as\n distributors in a chained transfer. For an example log entry, see Example log entries: AcceptResponsibilityTransfer in the\n Organizations User Guide.

" } }, "com.amazonaws.organizations#AcceptHandshakeRequest": { "type": "structure", "members": { "HandshakeId": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { "smithy.api#documentation": "

ID for the handshake that you want to accept.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#AcceptHandshakeResponse": { "type": "structure", "members": { "Handshake": { "target": "com.amazonaws.organizations#Handshake", "traits": { "smithy.api#documentation": "

A Handshake object. Contains details for the handshake.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy attached that\n grants the required permissions. For more information, see Access Management in the\n IAM User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.organizations#AccessDeniedForDependencyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" }, "Reason": { "target": "com.amazonaws.organizations#AccessDeniedForDependencyExceptionReason" } }, "traits": { "smithy.api#documentation": "

The operation that you attempted requires you to have the\n iam:CreateServiceLinkedRole for\n organizations.amazonaws.com permission so that Organizations can create the\n required service-linked role. You don't have that permission.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.organizations#AccessDeniedForDependencyExceptionReason": { "type": "enum", "members": { "ACCESS_DENIED_DURING_CREATE_SERVICE_LINKED_ROLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_DENIED_DURING_CREATE_SERVICE_LINKED_ROLE" } } } }, "com.amazonaws.organizations#Account": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the account.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

" } }, "Arn": { "target": "com.amazonaws.organizations#AccountArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "Email": { "target": "com.amazonaws.organizations#Email", "traits": { "smithy.api#documentation": "

The email address associated with the Amazon Web Services account.

\n

The regex pattern for this parameter is a string of characters that represents a\n standard internet email address.

" } }, "Name": { "target": "com.amazonaws.organizations#AccountName", "traits": { "smithy.api#documentation": "

The friendly name of the account.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, "Status": { "target": "com.amazonaws.organizations#AccountStatus", "traits": { "smithy.api#documentation": "

The status of the account in the organization.

\n \n

The Status parameter in the Account object will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" } }, "State": { "target": "com.amazonaws.organizations#AccountState", "traits": { "smithy.api#documentation": "

Each state represents a specific phase in the account lifecycle. Use this information\n to manage account access, automate workflows, or trigger actions based on account state\n changes.

\n

For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the\n Organizations User Guide.

" } }, "Paths": { "target": "com.amazonaws.organizations#Paths", "traits": { "smithy.api#documentation": "

The paths in the organization where the account exists.

" } }, "JoinedMethod": { "target": "com.amazonaws.organizations#AccountJoinedMethod", "traits": { "smithy.api#documentation": "

The method by which the account joined the organization.

" } }, "JoinedTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The date the account became a part of the organization.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about an Amazon Web Services account that is a member of an\n organization.

" } }, "com.amazonaws.organizations#AccountAlreadyClosedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You attempted to close an account that is already closed.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#AccountAlreadyRegisteredException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified account is already a delegated administrator for this Amazon Web Services\n service.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#AccountArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}$" } }, "com.amazonaws.organizations#AccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 12 }, "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.organizations#AccountJoinedMethod": { "type": "enum", "members": { "INVITED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVITED" } }, "CREATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATED" } } } }, "com.amazonaws.organizations#AccountName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\s\\S]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.organizations#AccountNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find an Amazon Web Services account with the AccountId that you specified, or\n the account whose credentials you used to make this request isn't a member of an\n organization.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#AccountNotRegisteredException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified account is not a delegated administrator for this Amazon Web Services service.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#AccountOwnerNotVerifiedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You can't invite an existing account to your organization until you verify that you\n own the email address associated with the management account. For more information, see\n Email address\n verification in the Organizations User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.organizations#AccountState": { "type": "enum", "members": { "PENDING_ACTIVATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ACTIVATION" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "SUSPENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSPENDED" } }, "PENDING_CLOSURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_CLOSURE" } }, "CLOSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSED" } } } }, "com.amazonaws.organizations#AccountStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "SUSPENDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUSPENDED" } }, "PENDING_CLOSURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_CLOSURE" } } } }, "com.amazonaws.organizations#Accounts": { "type": "list", "member": { "target": "com.amazonaws.organizations#Account" } }, "com.amazonaws.organizations#ActionType": { "type": "enum", "members": { "INVITE_ACCOUNT_TO_ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVITE" } }, "ENABLE_ALL_FEATURES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLE_ALL_FEATURES" } }, "APPROVE_ALL_FEATURES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPROVE_ALL_FEATURES" } }, "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE" } }, "TRANSFER_RESPONSIBILITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_RESPONSIBILITY" } } } }, "com.amazonaws.organizations#AlreadyInOrganizationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

This account is already a member of an organization. An account can belong to only one\n organization at a time.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#AttachPolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#AttachPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#DuplicatePolicyAttachmentException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#PolicyChangesInProgressException" }, { "target": "com.amazonaws.organizations#PolicyNotFoundException" }, { "target": "com.amazonaws.organizations#PolicyTypeNotEnabledException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TargetNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n Organizations User Guide for information about each policy type:

\n \n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To attach a policy to an account", "documentation": "The following example shows how to attach a service control policy (SCP) to an account:\n", "input": { "TargetId": "333333333333", "PolicyId": "p-examplepolicyid111" } }, { "title": "To attach a policy to an OU", "documentation": "The following example shows how to attach a service control policy (SCP) to an OU:\n", "input": { "TargetId": "ou-examplerootid111-exampleouid111", "PolicyId": "p-examplepolicyid111" } } ] } }, "com.amazonaws.organizations#AttachPolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.organizations#PolicyId", "traits": { "smithy.api#documentation": "

ID for the policy that you want to attach to the target. You can get the ID for the\n policy by calling the ListPolicies operation.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } }, "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { "smithy.api#documentation": "

ID for the root, OU, or account that you want to attach the policy to. You can get the\n ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts\n operations.

\n

The regex pattern for a target ID string requires one of the \n following:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#AwsManagedPolicy": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.organizations#CancelHandshake": { "type": "operation", "input": { "target": "com.amazonaws.organizations#CancelHandshakeRequest" }, "output": { "target": "com.amazonaws.organizations#CancelHandshakeResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#HandshakeAlreadyInStateException" }, { "target": "com.amazonaws.organizations#HandshakeNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidHandshakeTransitionException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Cancels a Handshake.

\n

Only the account that sent a handshake can call this operation. The recipient of the handshake can't cancel it, but can use DeclineHandshake to decline. After a handshake is canceled, the\n recipient can no longer respond to the handshake.

\n

You can view canceled handshakes in API responses for 30 days before they are\n deleted.

" } }, "com.amazonaws.organizations#CancelHandshakeRequest": { "type": "structure", "members": { "HandshakeId": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { "smithy.api#documentation": "

ID for the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#CancelHandshakeResponse": { "type": "structure", "members": { "Handshake": { "target": "com.amazonaws.organizations#Handshake", "traits": { "smithy.api#documentation": "

A Handshake object. Contains for the handshake that you canceled.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#Child": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#ChildId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of this child entity.

\n

The regex pattern for a child ID string requires one of the \n following:

\n " } }, "Type": { "target": "com.amazonaws.organizations#ChildType", "traits": { "smithy.api#documentation": "

The type of this child entity.

" } } }, "traits": { "smithy.api#documentation": "

Contains a list of child entities, either OUs or accounts.

" } }, "com.amazonaws.organizations#ChildId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 100 }, "smithy.api#pattern": "^(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" } }, "com.amazonaws.organizations#ChildNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find an organizational unit (OU) or Amazon Web Services account with the\n ChildId that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#ChildType": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT" } }, "ORGANIZATIONAL_UNIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATIONAL_UNIT" } } } }, "com.amazonaws.organizations#Children": { "type": "list", "member": { "target": "com.amazonaws.organizations#Child" } }, "com.amazonaws.organizations#CloseAccount": { "type": "operation", "input": { "target": "com.amazonaws.organizations#CloseAccountRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountAlreadyClosedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConflictException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Closes an Amazon Web Services member account within an organization. You can close an account when\n all\n features are enabled . You can't close the management account with this API.\n This is an asynchronous request that Amazon Web Services performs in the background. Because\n CloseAccount operates asynchronously, it can return a successful\n completion message even though account closure might still be in progress. You need to\n wait a few minutes before the account is fully closed. To check the status of the\n request, do one of the following:

\n \n \n \n \n

After the permanent termination of the account after the 90-day waiting period,\n Organizations logs a membership event in CloudTrail. The event is an\n AccountDepartedOrganization event with\n departureMethod:CLEANED and departureTime. This event is\n available only in the management account's event history.

" } }, "com.amazonaws.organizations#CloseAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

Retrieves the Amazon Web Services account Id for the current CloseAccount API request.\n

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ConcurrentModificationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The target of the operation is currently being modified by a different request. Try\n again later.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The request failed because it conflicts with the current state of the specified\n resource.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#ConstraintViolationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" }, "Reason": { "target": "com.amazonaws.organizations#ConstraintViolationExceptionReason" } }, "traits": { "smithy.api#documentation": "

Performing this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

\n
\n ", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#ConstraintViolationExceptionReason": { "type": "enum", "members": { "ACCOUNT_NUMBER_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_NUMBER_LIMIT_EXCEEDED" } }, "HANDSHAKE_RATE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HANDSHAKE_RATE_LIMIT_EXCEEDED" } }, "OU_NUMBER_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OU_NUMBER_LIMIT_EXCEEDED" } }, "OU_DEPTH_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OU_DEPTH_LIMIT_EXCEEDED" } }, "POLICY_NUMBER_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POLICY_NUMBER_LIMIT_EXCEEDED" } }, "POLICY_CONTENT_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POLICY_CONTENT_LIMIT_EXCEEDED" } }, "MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED" } }, "MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED" } }, "ACCOUNT_CANNOT_LEAVE_ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_CANNOT_LEAVE_ORGANIZATION" } }, "ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA" } }, "ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION" } }, "MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED" } }, "MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED" } }, "ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED" } }, "MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE" } }, "MASTER_ACCOUNT_MISSING_CONTACT_INFO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MASTER_ACCOUNT_MISSING_CONTACT_INFO" } }, "MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED" } }, "ORGANIZATION_NOT_IN_ALL_FEATURES_MODE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_NOT_IN_ALL_FEATURES_MODE" } }, "CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION" } }, "EMAIL_VERIFICATION_CODE_EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL_VERIFICATION_CODE_EXPIRED" } }, "WAIT_PERIOD_ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WAIT_PERIOD_ACTIVE" } }, "MAX_TAG_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_TAG_LIMIT_EXCEEDED" } }, "TAG_POLICY_VIOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TAG_POLICY_VIOLATION" } }, "MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED" } }, "CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR" } }, "CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG" } }, "DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE" } }, "POLICY_TYPE_ENABLED_FOR_THIS_SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "POLICY_TYPE_ENABLED_FOR_THIS_SERVICE" } }, "MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE" } }, "CANNOT_CLOSE_MANAGEMENT_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANNOT_CLOSE_MANAGEMENT_ACCOUNT" } }, "CLOSE_ACCOUNT_QUOTA_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSE_ACCOUNT_QUOTA_EXCEEDED" } }, "CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED" } }, "SERVICE_ACCESS_NOT_ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_ACCESS_NOT_ENABLED" } }, "INVALID_PAYMENT_INSTRUMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PAYMENT_INSTRUMENT" } }, "ACCOUNT_CREATION_NOT_COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_CREATION_NOT_COMPLETE" } }, "CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR" } }, "ALL_FEATURES_MIGRATION_ORGANIZATION_SIZE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL_FEATURES_MIGRATION_ORGANIZATION_SIZE_LIMIT_EXCEEDED" } }, "RESPONSIBILITY_TRANSFER_MAX_LEVEL_VIOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSIBILITY_TRANSFER_MAX_LEVEL_VIOLATION" } }, "RESPONSIBILITY_TRANSFER_MAX_INBOUND_QUOTA_VIOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSIBILITY_TRANSFER_MAX_INBOUND_QUOTA_VIOLATION" } }, "RESPONSIBILITY_TRANSFER_MAX_OUTBOUND_QUOTA_VIOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSIBILITY_TRANSFER_MAX_OUTBOUND_QUOTA_VIOLATION" } }, "RESPONSIBILITY_TRANSFER_MAX_TRANSFERS_QUOTA_VIOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSIBILITY_TRANSFER_MAX_TRANSFERS_QUOTA_VIOLATION" } }, "ACTIVE_RESPONSIBILITY_TRANSFER_PROCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE_RESPONSIBILITY_TRANSFER_PROCESS" } }, "TRANSFER_RESPONSIBILITY_TARGET_DELETION_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_RESPONSIBILITY_TARGET_DELETION_IN_PROGRESS" } }, "TRANSFER_RESPONSIBILITY_SOURCE_DELETION_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_RESPONSIBILITY_SOURCE_DELETION_IN_PROGRESS" } }, "UNSUPPORTED_PRICING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_PRICING" } }, "UNMET_BILLING_PREREQUISITE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNMET_BILLING_PREREQUISITE" } }, "ACCOUNT_NOT_ACTIVE_FOR_TRANSFER_RESPONSIBILITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_NOT_ACTIVE_FOR_TRANSFER_RESPONSIBILITY" } }, "TRANSFER_RESPONSIBILITY_UPDATE_NOT_ALLOWED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_RESPONSIBILITY_UPDATE_NOT_ALLOWED" } } } }, "com.amazonaws.organizations#CreateAccount": { "type": "operation", "input": { "target": "com.amazonaws.organizations#CreateAccountRequest" }, "output": { "target": "com.amazonaws.organizations#CreateAccountResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#FinalizingOrganizationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:

\n \n

Additionally, the AccountJoinedOrganization event is logged in CloudTrail and\n is available only in the management account's event history. This event includes\n joinedMethod:Created and joinedTime fields to provide context\n on how and when the account joined the organization.

\n

The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.

\n

You can only call this operation from the management account.

\n

For more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.

\n \n \n \n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.

\n
", "smithy.api#examples": [ { "title": "To create a new account that is automatically part of the organization", "documentation": "The owner of an organization creates a member account in the organization. The following example shows that when the organization owner creates the member account, the account is preconfigured with the name \"Production Account\" and an owner email address of susan@example.com. An IAM role is automatically created using the default name because the roleName parameter is not used. AWS Organizations sends Susan a \"Welcome to AWS\" email:\n\n", "input": { "Email": "susan@example.com", "AccountName": "Production Account" }, "output": { "CreateAccountStatus": { "State": "IN_PROGRESS", "Id": "car-examplecreateaccountrequestid111" } } } ] } }, "com.amazonaws.organizations#CreateAccountFailureReason": { "type": "enum", "members": { "ACCOUNT_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_LIMIT_EXCEEDED" } }, "EMAIL_ALREADY_EXISTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL_ALREADY_EXISTS" } }, "INVALID_ADDRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ADDRESS" } }, "INVALID_EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_EMAIL" } }, "CONCURRENT_ACCOUNT_MODIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONCURRENT_ACCOUNT_MODIFICATION" } }, "INTERNAL_FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INTERNAL_FAILURE" } }, "GOVCLOUD_ACCOUNT_ALREADY_EXISTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GOVCLOUD_ACCOUNT_ALREADY_EXISTS" } }, "MISSING_BUSINESS_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_BUSINESS_VALIDATION" } }, "FAILED_BUSINESS_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED_BUSINESS_VALIDATION" } }, "PENDING_BUSINESS_VALIDATIONv": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_BUSINESS_VALIDATION" } }, "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_IDENTITY_FOR_BUSINESS_VALIDATION" } }, "UNKNOWN_BUSINESS_VALIDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_BUSINESS_VALIDATION" } }, "MISSING_PAYMENT_INSTRUMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSING_PAYMENT_INSTRUMENT" } }, "INVALID_PAYMENT_INSTRUMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PAYMENT_INSTRUMENT" } }, "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_EXISTING_RESOURCE_POLICY_WITH_TAGS_NOT_SUPPORTED" } } } }, "com.amazonaws.organizations#CreateAccountName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^[\\u0020-\\u007E]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.organizations#CreateAccountRequest": { "type": "structure", "members": { "Email": { "target": "com.amazonaws.organizations#Email", "traits": { "smithy.api#documentation": "

The email address of the owner to assign to the new member account. This email address\n must not already be associated with another Amazon Web Services account. You must use a valid email\n address to complete account creation.

\n

The rules for a valid email address:

\n \n

You can't access the root user of the account or remove an account that was created\n with an invalid email address.

", "smithy.api#required": {} } }, "AccountName": { "target": "com.amazonaws.organizations#CreateAccountName", "traits": { "smithy.api#documentation": "

The friendly name of the member account.

", "smithy.api#required": {} } }, "RoleName": { "target": "com.amazonaws.organizations#RoleName", "traits": { "smithy.api#documentation": "

The name of an IAM role that Organizations automatically preconfigures in the new member\n account. This role trusts the management account, allowing users in the management\n account to assume the role, as permitted by the management account administrator. The\n role has administrator permissions in the new member account.

\n

If you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.

\n

For more information about how to use this role to access the member account, see the\n following links:

\n \n

The regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" } }, "IamUserAccessToBilling": { "target": "com.amazonaws.organizations#IAMUserAccessToBilling", "traits": { "smithy.api#documentation": "

If set to ALLOW, the new account enables IAM users to access account\n billing information if they have the required permissions. If set\n to DENY, only the root user of the new account can access account billing\n information. For more information, see About IAM\n access to the Billing and Cost Management console in the\n Amazon Web Services Billing and Cost Management User Guide.

\n

If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.

" } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags that you want to attach to the newly created account. For each tag in\n the list, you must specify both a tag key and a value. You can set the value to an empty\n string, but you can't set it to null. For more information about tagging,\n see Tagging Organizations\n resources in the Organizations User Guide.

\n \n

If any one of the tags is not valid or if you exceed the maximum allowed number of\n tags for an account, then the entire request fails and the account is not\n created.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#CreateAccountRequestId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 36 }, "smithy.api#pattern": "^car-[a-z0-9]{8,32}$" } }, "com.amazonaws.organizations#CreateAccountResponse": { "type": "structure", "members": { "CreateAccountStatus": { "target": "com.amazonaws.organizations#CreateAccountStatus", "traits": { "smithy.api#documentation": "

A structure that contains details about the request to create an account. This\n response structure might not be fully populated when you first receive it because\n account creation is an asynchronous process. You can pass the returned\n CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the\n request at later times. You can also check the CloudTrail log for the\n CreateAccountResult event. For more information, see Logging and monitoring in Organizations in the\n Organizations User Guide.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#CreateAccountState": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "SUCCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCEEDED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.organizations#CreateAccountStates": { "type": "list", "member": { "target": "com.amazonaws.organizations#CreateAccountState" } }, "com.amazonaws.organizations#CreateAccountStatus": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#CreateAccountRequestId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) that references this request. You get this value from the\n response of the initial CreateAccount request to create the\n account.

\n

The regex pattern for a create account request ID string \n requires \"car-\" followed by from 8 to 32 lowercase letters or digits.

" } }, "AccountName": { "target": "com.amazonaws.organizations#CreateAccountName", "traits": { "smithy.api#documentation": "

The account name given to the account when it was created.

" } }, "State": { "target": "com.amazonaws.organizations#CreateAccountState", "traits": { "smithy.api#documentation": "

The status of the asynchronous request to create an Amazon Web Services account.

" } }, "RequestedTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the request was made for the account creation.

" } }, "CompletedTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The date and time that the account was created and the request completed.

" } }, "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

If the account was created successfully, the unique identifier (ID) of the new\n account.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

" } }, "GovCloudAccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

If the account was created successfully, the ID for the new account in the Amazon Web Services\n GovCloud (US) Region.

" } }, "FailureReason": { "target": "com.amazonaws.organizations#CreateAccountFailureReason", "traits": { "smithy.api#documentation": "

If the request failed, a description of the reason for the failure.

\n " } } }, "traits": { "smithy.api#documentation": "

Contains the status about a CreateAccount or CreateGovCloudAccount request to create an Amazon Web Services account or an Amazon Web Services\n GovCloud (US) account in an organization.

" } }, "com.amazonaws.organizations#CreateAccountStatusNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find an create account request with the CreateAccountRequestId\n that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#CreateAccountStatuses": { "type": "list", "member": { "target": "com.amazonaws.organizations#CreateAccountStatus" } }, "com.amazonaws.organizations#CreateGovCloudAccount": { "type": "operation", "input": { "target": "com.amazonaws.organizations#CreateGovCloudAccountRequest" }, "output": { "target": "com.amazonaws.organizations#CreateGovCloudAccountResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#FinalizingOrganizationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

This action is available if all of the following are true:

\n \n

Organizations automatically creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.

\n

Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also\n do the following:

\n \n

If the request includes tags, then the requester must have the\n organizations:TagResource permission. The tags are attached to the\n commercial account associated with the GovCloud account, rather than the GovCloud\n account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud\n account exists.

\n

You call this action from the management account of your organization in the\n commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US)\n Region. After the account is created, the management account of an organization in the\n Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on\n inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see\n Organizations in the\n Amazon Web Services GovCloud User Guide.

\n

Calling CreateGovCloudAccount is an asynchronous request that Amazon Web Services\n performs in the background. Because CreateGovCloudAccount operates\n asynchronously, it can return a successful completion message even though account\n initialization might still be in progress. You might need to wait a few minutes before\n you can successfully access the account. To check the status of the request, do one of\n the following:

\n \n

Additionally, the AccountJoinedOrganization event is logged in CloudTrail and\n is available only in the management account's event history only for the linked\n commercial account. This event includes joinedMethod:Created and\n joinedTime fields to provide context on how and when the account joined\n the organization.

\n

\n

When you call the CreateGovCloudAccount action, you create two accounts:\n a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the\n commercial Region for billing and support purposes. The account in the commercial Region\n is automatically a member of the organization whose credentials made the request. Both\n accounts are associated with the same email address.

\n

A role is created in the new account in the commercial Region that allows the\n management account in the organization in the commercial Region to assume it. An Amazon Web Services\n GovCloud (US) account is then created and associated with the commercial account that\n you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can\n be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management\n account of the commercial organization. For more information and to view a diagram that\n explains how account access works, see Organizations in the\n Amazon Web Services GovCloud User Guide.

\n

For more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.

\n \n \n \n \n

When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n access to your billing information and tools.

\n
" } }, "com.amazonaws.organizations#CreateGovCloudAccountRequest": { "type": "structure", "members": { "Email": { "target": "com.amazonaws.organizations#Email", "traits": { "smithy.api#documentation": "

Specifies the email address of the owner to assign to the new member account in the\n commercial Region. This email address must not already be associated with another\n Amazon Web Services account. You must use a valid email address to complete account creation.

\n

The rules for a valid email address:

\n \n

You can't access the root user of the account or remove an account that was created\n with an invalid email address. Like all request parameters for\n CreateGovCloudAccount, the request for the email address for the Amazon Web Services\n GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud\n (US) Region.

", "smithy.api#required": {} } }, "AccountName": { "target": "com.amazonaws.organizations#CreateAccountName", "traits": { "smithy.api#documentation": "

The friendly name of the member account.

\n

The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or\n dot (.) You can't separate characters with a dash (\u2013).

", "smithy.api#required": {} } }, "RoleName": { "target": "com.amazonaws.organizations#RoleName", "traits": { "smithy.api#documentation": "

(Optional)

\n

The name of an IAM role that Organizations automatically preconfigures in the new member\n accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role\n trusts the management account, allowing users in the management account to assume the\n role, as permitted by the management account administrator. The role has administrator\n permissions in the new member account.

\n

If you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.

\n

For more information about how to use this role to access the member account, see the\n following links:

\n \n

The regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" } }, "IamUserAccessToBilling": { "target": "com.amazonaws.organizations#IAMUserAccessToBilling", "traits": { "smithy.api#documentation": "

If set to ALLOW, the new linked account in the commercial Region enables\n IAM users to access account billing information if they have the\n required permissions. If set to DENY, only the root user of the new account\n can access account billing information. For more information, see About IAM\n access to the Billing and Cost Management console in the\n Amazon Web Services Billing and Cost Management User Guide.

\n

If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.

" } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags that you want to attach to the newly created account. These tags are\n attached to the commercial account associated with the GovCloud account, and not to the\n GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud\n account exists.

\n

For each tag in the list, you must specify both a tag key and a value. You can set the\n value to an empty string, but you can't set it to null. For more\n information about tagging, see Tagging Organizations resources in the\n Organizations User Guide.

\n \n

If any one of the tags is not valid or if you exceed the maximum allowed number of\n tags for an account, then the entire request fails and the account is not\n created.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#CreateGovCloudAccountResponse": { "type": "structure", "members": { "CreateAccountStatus": { "target": "com.amazonaws.organizations#CreateAccountStatus" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#CreateOrganization": { "type": "operation", "input": { "target": "com.amazonaws.organizations#CreateOrganizationRequest" }, "output": { "target": "com.amazonaws.organizations#CreateOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccessDeniedForDependencyException" }, { "target": "com.amazonaws.organizations#AlreadyInOrganizationException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Creates an Amazon Web Services organization. The account whose user is calling the\n CreateOrganization operation automatically becomes the management account of the new organization.

\n

This operation must be called using credentials from the account that is to become the\n new organization's management account. The principal must also have the relevant IAM\n permissions.

\n

By default (or if you set the FeatureSet parameter to ALL),\n the new organization is created with all features enabled and service control policies\n automatically enabled in the root. If you instead choose to create the organization\n supporting only the consolidated billing features by setting the FeatureSet\n parameter to CONSOLIDATED_BILLING, no policy types are enabled by default\n and you can't use organization policies.

\n

The AccountJoinedOrganization event is logged in CloudTrail and\n is available only in the management account's event history. This event includes\n joinedMethod:INVITED and joinedTime fields to provide\n context on how and when the account joined the organization.

", "smithy.api#examples": [ { "title": "To create a new organization with all features enabled", "documentation": "Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a feature set, the new organization defaults to all features enabled and service control policies enabled on the root:\n\n", "output": { "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" } } }, { "title": "To create a new organization with consolidated billing features only", "documentation": "In the following example, Bill creates an organization using credentials from account 111111111111, and configures the organization to support only the consolidated billing feature set:\n\n", "input": { "FeatureSet": "CONSOLIDATED_BILLING" }, "output": { "Organization": { "AvailablePolicyTypes": [], "MasterAccountId": "111111111111", "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "FeatureSet": "CONSOLIDATED_BILLING", "Id": "o-exampleorgid", "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid" } } } ] } }, "com.amazonaws.organizations#CreateOrganizationRequest": { "type": "structure", "members": { "FeatureSet": { "target": "com.amazonaws.organizations#OrganizationFeatureSet", "traits": { "smithy.api#documentation": "

Specifies the feature set supported by the new organization. Each feature set supports\n different levels of functionality.

\n " } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#CreateOrganizationResponse": { "type": "structure", "members": { "Organization": { "target": "com.amazonaws.organizations#Organization", "traits": { "smithy.api#documentation": "

A structure that contains details about the newly created organization.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#CreateOrganizationalUnit": { "type": "operation", "input": { "target": "com.amazonaws.organizations#CreateOrganizationalUnitRequest" }, "output": { "target": "com.amazonaws.organizations#CreateOrganizationalUnitResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#DuplicateOrganizationalUnitException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ParentNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Creates an organizational unit (OU) within a root or parent OU. An OU is a container\n for accounts that enables you to organize your accounts to apply policies according to\n your business requirements. The number of levels deep that you can nest OUs is dependent\n upon the policy types enabled for that root. For service control policies, the limit is\n five.

\n

For more information about OUs, see Managing organizational units (OUs) in the\n Organizations User Guide.

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

You can only call this operation from the management account.

", "smithy.api#examples": [ { "title": "To create a new organization unit", "documentation": "The following example shows how to create an OU that is named AccountingOU. The new OU is directly under the root.:\n\n", "input": { "ParentId": "r-examplerootid111", "Name": "AccountingOU" }, "output": { "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Name": "AccountingOU" } } } ] } }, "com.amazonaws.organizations#CreateOrganizationalUnitRequest": { "type": "structure", "members": { "ParentId": { "target": "com.amazonaws.organizations#ParentId", "traits": { "smithy.api#documentation": "

ID for the parent root or OU that you want to create the new OU in.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n ", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.organizations#OrganizationalUnitName", "traits": { "smithy.api#documentation": "

The friendly name to assign to the new OU.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags that you want to attach to the newly created OU. For each tag in the\n list, you must specify both a tag key and a value. You can set the value to an empty\n string, but you can't set it to null. For more information about tagging,\n see Tagging Organizations\n resources in the Organizations User Guide.

\n \n

If any one of the tags is not valid or if you exceed the allowed number of tags\n for an OU, then the entire request fails and the OU is not created.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#CreateOrganizationalUnitResponse": { "type": "structure", "members": { "OrganizationalUnit": { "target": "com.amazonaws.organizations#OrganizationalUnit", "traits": { "smithy.api#documentation": "

A structure that contains details about the newly created OU.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#CreatePolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#CreatePolicyRequest" }, "output": { "target": "com.amazonaws.organizations#CreatePolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#DuplicatePolicyException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.organizations#PolicyTypeNotAvailableForOrganizationException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Creates a policy of a specified type that you can attach to a root, an organizational\n unit (OU), or an individual Amazon Web Services account.

\n

For more information about policies and their use, see Managing\n Organizations policies.

\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To create a service control policy", "documentation": "The following example shows how to create a service control policy (SCP) that is named AllowAllS3Actions. The JSON string in the content parameter specifies the content in the policy. The parameter string is escaped with backslashes to ensure that the embedded double quotes in the JSON policy are treated as literals in the parameter, which itself is surrounded by double quotes:\n\n", "input": { "Content": "{\\\"Version\\\":\\\"2012-10-17\\\",\\\"Statement\\\":{\\\"Effect\\\":\\\"Allow\\\",\\\"Action\\\":\\\"s3:*\\\"}}", "Type": "SERVICE_CONTROL_POLICY", "Description": "Enables admins of attached accounts to delegate all S3 permissions", "Name": "AllowAllS3Actions" }, "output": { "Policy": { "Content": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\"}}", "PolicySummary": { "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", "Description": "Allows delegation of all S3 actions", "Name": "AllowAllS3Actions", "Type": "SERVICE_CONTROL_POLICY" } } } } ] } }, "com.amazonaws.organizations#CreatePolicyRequest": { "type": "structure", "members": { "Content": { "target": "com.amazonaws.organizations#PolicyContent", "traits": { "smithy.api#documentation": "

The policy text content to add to the new policy. The text that you supply must adhere\n to the rules of the policy type you specify in the Type parameter.

\n

The maximum size of a policy document depends on the policy's type. For more\n information, see Maximum and minimum values in the\n Organizations User Guide.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.organizations#PolicyDescription", "traits": { "smithy.api#documentation": "

An optional description to assign to the policy.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.organizations#PolicyName", "traits": { "smithy.api#documentation": "

The friendly name to assign to the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.organizations#PolicyType", "traits": { "smithy.api#documentation": "

The type of policy to create. You can specify one of the following values:

\n ", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags that you want to attach to the newly created policy. For each tag in\n the list, you must specify both a tag key and a value. You can set the value to an empty\n string, but you can't set it to null. For more information about tagging,\n see Tagging Organizations\n resources in the Organizations User Guide.

\n \n

If any one of the tags is not valid or if you exceed the allowed number of tags\n for a policy, then the entire request fails and the policy is not created.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#CreatePolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.organizations#Policy", "traits": { "smithy.api#documentation": "

A structure that contains details about the newly created policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DeclineHandshake": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DeclineHandshakeRequest" }, "output": { "target": "com.amazonaws.organizations#DeclineHandshakeResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#HandshakeAlreadyInStateException" }, { "target": "com.amazonaws.organizations#HandshakeNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidHandshakeTransitionException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Declines a Handshake.

\n

Only the account that receives a handshake can call this operation. The sender of the handshake can use CancelHandshake to\n cancel if the handshake hasn't yet been responded to.

\n

You can view canceled handshakes in API responses for 30 days before they are\n deleted.

", "smithy.api#examples": [ { "title": "To decline a handshake sent from the master account", "documentation": "The following example shows Susan declining an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED:", "input": { "HandshakeId": "h-examplehandshakeid111" }, "output": { "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": "ACCOUNT", "Value": "222222222222" }, { "Type": "NOTES", "Value": "This is an invitation to Susan's account to join the Bill's organization." } ], "Parties": [ { "Type": "ACCOUNT", "Id": "222222222222" }, { "Type": "ORGANIZATION", "Id": "o-exampleorgid" } ], "Action": "INVITE", "RequestedTimestamp": "2016-11-30T19:27:58Z", "ExpirationTimestamp": "2016-12-15T19:27:58Z", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" } } } ] } }, "com.amazonaws.organizations#DeclineHandshakeRequest": { "type": "structure", "members": { "HandshakeId": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { "smithy.api#documentation": "

ID for the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DeclineHandshakeResponse": { "type": "structure", "members": { "Handshake": { "target": "com.amazonaws.organizations#Handshake", "traits": { "smithy.api#documentation": "

A Handshake object. Contains details for the declined handshake.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DelegatedAdministrator": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the delegated administrator's account.

" } }, "Arn": { "target": "com.amazonaws.organizations#AccountArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the delegated administrator's account.

" } }, "Email": { "target": "com.amazonaws.organizations#Email", "traits": { "smithy.api#documentation": "

The email address that is associated with the delegated administrator's Amazon Web Services\n account.

" } }, "Name": { "target": "com.amazonaws.organizations#AccountName", "traits": { "smithy.api#documentation": "

The friendly name of the delegated administrator's account.

" } }, "Status": { "target": "com.amazonaws.organizations#AccountStatus", "traits": { "smithy.api#documentation": "

The status of the delegated administrator's account in the organization.

" } }, "State": { "target": "com.amazonaws.organizations#AccountState", "traits": { "smithy.api#documentation": "

Each state represents a specific phase in the account lifecycle. Use this information\n to manage account access, automate workflows, or trigger actions based on account state\n changes.

\n

For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the\n Organizations User Guide.

" } }, "JoinedMethod": { "target": "com.amazonaws.organizations#AccountJoinedMethod", "traits": { "smithy.api#documentation": "

The method by which the delegated administrator's account joined the\n organization.

" } }, "JoinedTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The date when the delegated administrator's account became a part of the\n organization.

" } }, "DelegationEnabledDate": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The date when the account was made a delegated administrator.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the delegated administrator.

" } }, "com.amazonaws.organizations#DelegatedAdministrators": { "type": "list", "member": { "target": "com.amazonaws.organizations#DelegatedAdministrator" } }, "com.amazonaws.organizations#DelegatedService": { "type": "structure", "members": { "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The name of an Amazon Web Services service that can request an operation for the specified service.\n This is typically in the form of a URL, such as:\n \n servicename.amazonaws.com.

" } }, "DelegationEnabledDate": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The date that the account became a delegated administrator for this service.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the Amazon Web Services service for which the account is a delegated\n administrator.

" } }, "com.amazonaws.organizations#DelegatedServices": { "type": "list", "member": { "target": "com.amazonaws.organizations#DelegatedService" } }, "com.amazonaws.organizations#DeleteOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#OrganizationNotEmptyException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Deletes the organization. You can delete an organization only by using credentials\n from the management account. The organization must be empty of member accounts.

\n

When an organization is deleted, Organizations logs a membership event in CloudTrail. The\n event is an AccountDepartedOrganization event with\n departureMethod:LEFT and departureTime. This event is available\n only in the management account's event history.

" } }, "com.amazonaws.organizations#DeleteOrganizationalUnit": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DeleteOrganizationalUnitRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#OrganizationalUnitNotEmptyException" }, { "target": "com.amazonaws.organizations#OrganizationalUnitNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Deletes an organizational unit (OU) from a root or another OU. You must first remove\n all accounts and child OUs from the OU that you want to delete.

\n

You can only call this operation from the management account.

", "smithy.api#examples": [ { "title": "To delete an organization unit", "documentation": "The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU:\n\n", "input": { "OrganizationalUnitId": "ou-examplerootid111-exampleouid111" } } ] } }, "com.amazonaws.organizations#DeleteOrganizationalUnitRequest": { "type": "structure", "members": { "OrganizationalUnitId": { "target": "com.amazonaws.organizations#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

ID for the organizational unit that you want to delete. You can get the ID from the\n ListOrganizationalUnitsForParent operation.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DeletePolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DeletePolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#PolicyInUseException" }, { "target": "com.amazonaws.organizations#PolicyNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Deletes the specified policy from your organization. Before you perform this\n operation, you must first detach the policy from all organizational units (OUs), roots,\n and accounts.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To delete a policy", "documentation": "The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities:\n\n", "input": { "PolicyId": "p-examplepolicyid111" } } ] } }, "com.amazonaws.organizations#DeletePolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.organizations#PolicyId", "traits": { "smithy.api#documentation": "

ID for the policy that you want to delete. You can get the ID from the ListPolicies or ListPoliciesForTarget\n operations.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DeleteResourcePolicy": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#ResourcePolicyNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Deletes the resource policy from your organization.

\n

You can only call this operation from the management account.

" } }, "com.amazonaws.organizations#DeregisterDelegatedAdministrator": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DeregisterDelegatedAdministratorRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AccountNotRegisteredException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Removes the specified member Amazon Web Services account as a delegated administrator for the\n specified Amazon Web Services service.

\n \n

Deregistering a delegated administrator can have unintended impacts on the\n functionality of the enabled Amazon Web Services service. See the documentation for the enabled\n service before you deregister a delegated administrator so that you understand any\n potential impacts.

\n
\n

You can run this action only for Amazon Web Services services that support this\n feature. For a current list of services that support it, see the column Supports \n Delegated Administrator in the table at Amazon Web Services Services that you can use with \n Organizations in the Organizations User Guide.\n

\n

You can only call this operation from the management account.

" } }, "com.amazonaws.organizations#DeregisterDelegatedAdministratorRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The account ID number of the member account in the organization that you want to\n deregister as a delegated administrator.

", "smithy.api#required": {} } }, "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The service principal name of an Amazon Web Services service for which the account is a delegated\n administrator.

\n

Delegated administrator privileges are revoked for only the specified Amazon Web Services service\n from the member account. If the specified service is the only service for which the\n member account is a delegated administrator, the operation also revokes Organizations read action\n permissions.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribeAccount": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DescribeAccountRequest" }, "output": { "target": "com.amazonaws.organizations#DescribeAccountResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Retrieves Organizations-related information about the specified account.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To get the details about an account", "documentation": "The following example shows a user in the master account (111111111111) asking for details about account 555555555555:", "input": { "AccountId": "555555555555" }, "output": { "Account": { "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", "Id": "555555555555", "Email": "anika@example.com", "Name": "Beta Account" } } } ] } }, "com.amazonaws.organizations#DescribeAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the Amazon Web Services account that you want information about. You\n can get the ID from the ListAccounts or ListAccountsForParent operations.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribeAccountResponse": { "type": "structure", "members": { "Account": { "target": "com.amazonaws.organizations#Account", "traits": { "smithy.api#documentation": "

A structure that contains information about the requested account.

\n \n

The Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribeCreateAccountStatus": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DescribeCreateAccountStatusRequest" }, "output": { "target": "com.amazonaws.organizations#DescribeCreateAccountStatusResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#CreateAccountStatusNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Retrieves the current status of an asynchronous request to create an account.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To get information about a request to create an account", "documentation": "The following example shows how to request the status about a previous request to create an account in an organization. This operation can be called only by a principal from the organization's master account. In the example, the specified \"createAccountRequestId\" comes from the response of the original call to \"CreateAccount\":", "input": { "CreateAccountRequestId": "car-exampleaccountcreationrequestid" }, "output": { "CreateAccountStatus": { "State": "SUCCEEDED", "AccountId": "333333333333", "Id": "car-exampleaccountcreationrequestid" } } } ] } }, "com.amazonaws.organizations#DescribeCreateAccountStatusRequest": { "type": "structure", "members": { "CreateAccountRequestId": { "target": "com.amazonaws.organizations#CreateAccountRequestId", "traits": { "smithy.api#documentation": "

Specifies the Id value that uniquely identifies the\n CreateAccount request. You can get the value from the\n CreateAccountStatus.Id response in an earlier CreateAccount request, or from the ListCreateAccountStatus operation.

\n

The regex pattern for a create account request ID string \n requires \"car-\" followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribeCreateAccountStatusResponse": { "type": "structure", "members": { "CreateAccountStatus": { "target": "com.amazonaws.organizations#CreateAccountStatus", "traits": { "smithy.api#documentation": "

A structure that contains the current status of an account creation request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribeEffectivePolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DescribeEffectivePolicyRequest" }, "output": { "target": "com.amazonaws.organizations#DescribeEffectivePolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#EffectivePolicyNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TargetNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.

\n

This operation applies only to management policies. It does not apply to authorization\n policies: service control policies (SCPs) and resource control policies (RCPs).

\n

For more information about policy inheritance, see Understanding\n management policy inheritance in the\n Organizations User Guide.

\n

You can call this operation from any account in a organization.

" } }, "com.amazonaws.organizations#DescribeEffectivePolicyRequest": { "type": "structure", "members": { "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", "smithy.api#required": {} } }, "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { "smithy.api#documentation": "

When you're signed in as the management account, specify the ID of the account that\n you want details about. Specifying an organization root or organizational unit (OU) as\n the target is not supported.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribeEffectivePolicyResponse": { "type": "structure", "members": { "EffectivePolicy": { "target": "com.amazonaws.organizations#EffectivePolicy", "traits": { "smithy.api#documentation": "

The contents of the effective policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribeHandshake": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DescribeHandshakeRequest" }, "output": { "target": "com.amazonaws.organizations#DescribeHandshakeResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#HandshakeNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Returns details for a handshake. A handshake is the secure exchange of information\n between two Amazon Web Services accounts: a sender and a recipient.

\n

You can view ACCEPTED, DECLINED, or CANCELED\n handshakes in API Responses for 30 days before they are deleted.

\n

You can call this operation from any account in a organization.

", "smithy.api#examples": [ { "title": "To get information about a handshake", "documentation": "The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to \"InviteAccountToOrganization\", or from a call to \"ListHandshakesForAccount\" or \"ListHandshakesForOrganization\":", "input": { "HandshakeId": "h-examplehandshakeid111" }, "output": { "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": "ACCOUNT", "Value": "333333333333" } ], "Parties": [ { "Type": "ORGANIZATION", "Id": "o-exampleorgid" }, { "Type": "ACCOUNT", "Id": "333333333333" } ], "Action": "INVITE", "RequestedTimestamp": "2016-11-30T17:24:58.046Z", "ExpirationTimestamp": "2016-11-30T17:24:58.046Z", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" } } } ] } }, "com.amazonaws.organizations#DescribeHandshakeRequest": { "type": "structure", "members": { "HandshakeId": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { "smithy.api#documentation": "

ID for the handshake that you want information about.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribeHandshakeResponse": { "type": "structure", "members": { "Handshake": { "target": "com.amazonaws.organizations#Handshake", "traits": { "smithy.api#documentation": "

A Handshake object. Contains details for the handshake.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribeOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.organizations#DescribeOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about the organization that the user's account belongs\n to.

\n

You can call this operation from any account in a organization.

\n \n

Even if a policy type is shown as available in the organization, you can disable\n it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified\n root.

\n
", "smithy.api#examples": [ { "title": "To get information about an organization", "documentation": "The following example shows how to request information about the current user's organization:/n/n", "output": { "Organization": { "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", "MasterAccountEmail": "bill@example.com", "Id": "o-exampleorgid", "FeatureSet": "ALL", "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", "AvailablePolicyTypes": [ { "Status": "ENABLED", "Type": "SERVICE_CONTROL_POLICY" } ] } } } ] } }, "com.amazonaws.organizations#DescribeOrganizationResponse": { "type": "structure", "members": { "Organization": { "target": "com.amazonaws.organizations#Organization", "traits": { "smithy.api#documentation": "

A structure that contains information about the organization.

\n \n

The AvailablePolicyTypes part of the response is deprecated, and you\n shouldn't use it in your apps. It doesn't include any policy type supported by Organizations\n other than SCPs. In the China (Ningxia) Region, no policy type is included. To\n determine which policy types are enabled in your organization, use the \n ListRoots\n operation.

\n
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribeOrganizationalUnit": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DescribeOrganizationalUnitRequest" }, "output": { "target": "com.amazonaws.organizations#DescribeOrganizationalUnitResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#OrganizationalUnitNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about an organizational unit (OU).

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To get information about an organizational unit", "documentation": "The following example shows how to request details about an OU:", "input": { "OrganizationalUnitId": "ou-examplerootid111-exampleouid111" }, "output": { "OrganizationalUnit": { "Name": "Accounting Group", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Id": "ou-examplerootid111-exampleouid111" } } } ] } }, "com.amazonaws.organizations#DescribeOrganizationalUnitRequest": { "type": "structure", "members": { "OrganizationalUnitId": { "target": "com.amazonaws.organizations#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

ID for the organizational unit that you want details about. You can get the ID from\n the ListOrganizationalUnitsForParent operation.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribeOrganizationalUnitResponse": { "type": "structure", "members": { "OrganizationalUnit": { "target": "com.amazonaws.organizations#OrganizationalUnit", "traits": { "smithy.api#documentation": "

A structure that contains details about the specified OU.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribePolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DescribePolicyRequest" }, "output": { "target": "com.amazonaws.organizations#DescribePolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#PolicyNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about a policy.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To get information about a policy", "documentation": "The following example shows how to request information about a policy:/n/n", "input": { "PolicyId": "p-examplepolicyid111" }, "output": { "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" } } } } ] } }, "com.amazonaws.organizations#DescribePolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.organizations#PolicyId", "traits": { "smithy.api#documentation": "

ID for the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget\n operations.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribePolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.organizations#Policy", "traits": { "smithy.api#documentation": "

A structure that contains details about the specified policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribeResourcePolicy": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.organizations#DescribeResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#ResourcePolicyNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Retrieves information about a resource policy.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

" } }, "com.amazonaws.organizations#DescribeResourcePolicyResponse": { "type": "structure", "members": { "ResourcePolicy": { "target": "com.amazonaws.organizations#ResourcePolicy", "traits": { "smithy.api#documentation": "

A structure that contains details about the resource policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DescribeResponsibilityTransfer": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DescribeResponsibilityTransferRequest" }, "output": { "target": "com.amazonaws.organizations#DescribeResponsibilityTransferResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ResponsibilityTransferNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Returns details for a transfer. A transfer is an arrangement\n between two management accounts where one account designates the other with specified\n responsibilities for their organization.

" } }, "com.amazonaws.organizations#DescribeResponsibilityTransferRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#ResponsibilityTransferId", "traits": { "smithy.api#documentation": "

ID for the transfer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DescribeResponsibilityTransferResponse": { "type": "structure", "members": { "ResponsibilityTransfer": { "target": "com.amazonaws.organizations#ResponsibilityTransfer", "traits": { "smithy.api#documentation": "

A ResponsibilityTransfer object. Contains details for a transfer.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DestinationParentNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find the destination container (a root or OU) with the ParentId\n that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#DetachPolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DetachPolicyRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#PolicyChangesInProgressException" }, { "target": "com.amazonaws.organizations#PolicyNotAttachedException" }, { "target": "com.amazonaws.organizations#PolicyNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TargetNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Detaches a policy from a target root, organizational unit (OU), or account.

\n \n

If the policy being detached is a service control policy (SCP), the changes to\n permissions for Identity and Access Management (IAM) users and roles in affected accounts are\n immediate.

\n
\n

Every root, OU, and account must have at least one SCP attached. If you want to\n replace the default FullAWSAccess policy with an SCP that limits the\n permissions that can be delegated, you must attach the replacement SCP before you can\n remove the default SCP. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and\n leave the FullAWSAccess SCP still attached, and specify \"Effect\":\n \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in\n the FullAWSAccess policy (or any other attached SCP), you're using the\n authorization strategy of a \"deny list\".

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To detach a policy from a root, OU, or account", "documentation": "The following example shows how to detach a policy from an OU:/n/n", "input": { "TargetId": "ou-examplerootid111-exampleouid111", "PolicyId": "p-examplepolicyid111" } } ] } }, "com.amazonaws.organizations#DetachPolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.organizations#PolicyId", "traits": { "smithy.api#documentation": "

ID for the policy you want to detach. You can get the ID from the ListPolicies or ListPoliciesForTarget\n operations.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } }, "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { "smithy.api#documentation": "

ID for the root, OU, or account that you want to detach the policy from. You can get\n the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts\n operations.

\n

The regex pattern for a target ID string requires one of the \n following:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DisableAWSServiceAccess": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DisableAWSServiceAccessRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Disables the integration of an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with Organizations. When you disable integration, the\n specified service no longer can create a service-linked role in\n new accounts in your organization. This means the service can't\n perform operations on your behalf on any new accounts in your organization. The service\n can still perform operations in older accounts until the service completes its clean-up\n from Organizations.

\n \n

We \n strongly recommend\n that\n you don't use this command to disable integration between Organizations and the specified\n Amazon Web Services service. Instead, use the console or commands that are provided by the\n specified service. This lets the trusted service perform any required initialization\n when enabling trusted access, such as creating any required resources and any\n required clean up of resources when disabling trusted access.

\n

For information about how to disable trusted service access to your organization\n using the trusted service, see the Learn more link\n under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page.

\n

If you disable access by using this command, it causes the following actions to\n occur:

\n \n

Using the other service's console or commands to disable the integration ensures\n that the other service is aware that it can clean up any resources that are required\n only for the integration. How the service cleans up its resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.

\n
\n

After you perform the DisableAWSServiceAccess operation, the specified\n service can no longer perform operations in your organization's accounts

\n

For more information about integrating other services with Organizations, including the\n list of services that work with Organizations, see Using Organizations with other Amazon Web Services\n services in the Organizations User Guide.

\n

You can only call this operation from the management account.

" } }, "com.amazonaws.organizations#DisableAWSServiceAccessRequest": { "type": "structure", "members": { "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The service principal name of the Amazon Web Services service for which you want to disable\n integration with your organization. This is typically in the form of a URL, such as\n \n service-abbreviation.amazonaws.com.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DisablePolicyType": { "type": "operation", "input": { "target": "com.amazonaws.organizations#DisablePolicyTypeRequest" }, "output": { "target": "com.amazonaws.organizations#DisablePolicyTypeResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#PolicyChangesInProgressException" }, { "target": "com.amazonaws.organizations#PolicyTypeNotEnabledException" }, { "target": "com.amazonaws.organizations#RootNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.

\n

This is an asynchronous request that Amazon Web Services performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

\n

To view the status of available policy types in the organization, use ListRoots.

", "smithy.api#examples": [ { "title": "To disable a policy type in a root", "documentation": "The following example shows how to disable the service control policy (SCP) policy type in a root. The response shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY:/n/n", "input": { "RootId": "r-examplerootid111", "PolicyType": "SERVICE_CONTROL_POLICY" }, "output": { "Root": { "PolicyTypes": [], "Name": "Root", "Id": "r-examplerootid111", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } } } ] } }, "com.amazonaws.organizations#DisablePolicyTypeRequest": { "type": "structure", "members": { "RootId": { "target": "com.amazonaws.organizations#RootId", "traits": { "smithy.api#documentation": "

ID for the root in which you want to disable a policy type. You can get the ID from\n the ListRoots operation.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.organizations#PolicyType", "traits": { "smithy.api#documentation": "

The policy type that you want to disable in this root. You can specify one of the\n following values:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#DisablePolicyTypeResponse": { "type": "structure", "members": { "Root": { "target": "com.amazonaws.organizations#Root", "traits": { "smithy.api#documentation": "

A structure that shows the root with the updated list of enabled policy types.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#DuplicateAccountException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

That account is already present in the specified destination.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#DuplicateHandshakeException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

A handshake with the same action and target already exists. For example, if you\n invited an account to join your organization, the invited account might already have a\n pending invitation from this organization. If you intend to resend an invitation to an\n account, ensure that existing handshakes that might be considered duplicates are\n canceled or declined.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#DuplicateOrganizationalUnitException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

An OU with the same name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#DuplicatePolicyAttachmentException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The selected policy is already attached to the specified target.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#DuplicatePolicyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

A policy with the same name already exists.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#EffectivePolicy": { "type": "structure", "members": { "PolicyContent": { "target": "com.amazonaws.organizations#PolicyContent", "traits": { "smithy.api#documentation": "

The text content of the policy.

" } }, "LastUpdatedTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The time of the last update to this policy.

" } }, "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { "smithy.api#documentation": "

The account ID of the policy target.

" } }, "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { "smithy.api#documentation": "

The policy type.

" } } }, "traits": { "smithy.api#documentation": "

Contains rules to be applied to the affected accounts. The effective policy is the\n aggregation of any policies the account inherits, plus any policy directly attached to\n the account.

" } }, "com.amazonaws.organizations#EffectivePolicyNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

If you ran this action on the management account, this policy type is not enabled. If\n you ran the action on a member account, the account doesn't have an effective policy of\n this type. Contact the administrator of your organization about attaching a policy of\n this type to the account.

", "smithy.api#error": "client" } }, "com.amazonaws.organizations#EffectivePolicyType": { "type": "enum", "members": { "TAG_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TAG_POLICY" } }, "BACKUP_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_POLICY" } }, "AISERVICES_OPT_OUT_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AISERVICES_OPT_OUT_POLICY" } }, "CHATBOT_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHATBOT_POLICY" } }, "DECLARATIVE_POLICY_EC2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DECLARATIVE_POLICY_EC2" } }, "SECURITYHUB_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITYHUB_POLICY" } }, "SECURITYHUB_CSPM_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITYHUB_CSPM_POLICY" } }, "INSPECTOR_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSPECTOR_POLICY" } }, "UPGRADE_ROLLOUT_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPGRADE_ROLLOUT_POLICY" } }, "BEDROCK_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEDROCK_POLICY" } }, "S3_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3_POLICY" } }, "NETWORK_SECURITY_DIRECTOR_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NETWORK_SECURITY_DIRECTOR_POLICY" } }, "GUARDDUTY_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GUARDDUTY_POLICY" } } } }, "com.amazonaws.organizations#EffectivePolicyValidationError": { "type": "structure", "members": { "ErrorCode": { "target": "com.amazonaws.organizations#ErrorCode", "traits": { "smithy.api#documentation": "

The error code for the validation error. For example,\n ELEMENTS_TOO_MANY.

" } }, "ErrorMessage": { "target": "com.amazonaws.organizations#ErrorMessage", "traits": { "smithy.api#documentation": "

The error message for the validation error.

" } }, "PathToError": { "target": "com.amazonaws.organizations#PathToError", "traits": { "smithy.api#documentation": "

The path within the effective policy where the validation error occurred.

" } }, "ContributingPolicies": { "target": "com.amazonaws.organizations#PolicyIds", "traits": { "smithy.api#documentation": "

The individual policies inherited and attached to\n the account which contributed to the validation error.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about the validation errors that occurred when generating or\n enforcing an effective\n policy, such as which policies contributed to the error and location of the\n error.

" } }, "com.amazonaws.organizations#EffectivePolicyValidationErrors": { "type": "list", "member": { "target": "com.amazonaws.organizations#EffectivePolicyValidationError" } }, "com.amazonaws.organizations#Email": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 64 }, "smithy.api#pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.organizations#EnableAWSServiceAccess": { "type": "operation", "input": { "target": "com.amazonaws.organizations#EnableAWSServiceAccessRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Provides an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with permissions to view the structure of an\n organization, create a service-linked role in\n all the accounts in the organization, and allow the service to perform operations on\n behalf of the organization and its accounts. Establishing these permissions can be a\n first step in enabling the integration of an Amazon Web Services service with Organizations.

\n \n

We recommend that you enable integration between Organizations and the specified Amazon Web Services\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.

\n
\n

For more information about enabling services to integrate with Organizations, see Using\n Organizations with other Amazon Web Services services in the\n Organizations User Guide.

\n

You can only call this operation from the management account.

" } }, "com.amazonaws.organizations#EnableAWSServiceAccessRequest": { "type": "structure", "members": { "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The service principal name of the Amazon Web Services service for which you want to enable\n integration with your organization. This is typically in the form of a URL, such as\n \n service-abbreviation.amazonaws.com.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#EnableAllFeatures": { "type": "operation", "input": { "target": "com.amazonaws.organizations#EnableAllFeaturesRequest" }, "output": { "target": "com.amazonaws.organizations#EnableAllFeaturesResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#HandshakeConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Enables all features in an organization. This enables the use of organization policies\n that can restrict the services and actions that can be called in each account. Until you\n enable all features, you have access only to consolidated billing, and you can't use any\n of the advanced account administration features that Organizations supports. For more\n information, see Enabling all features in your organization in the\n Organizations User Guide.

\n \n

This operation is required only for organizations that were created explicitly\n with only the consolidated billing features enabled. Calling this operation sends a\n handshake to every invited account in the organization. The feature set change can\n be finalized and the additional features enabled only after all administrators in\n the invited accounts approve the change by accepting the handshake.

\n
\n

After you enable all features, you can separately enable or disable individual policy\n types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use\n ListRoots.

\n

After all invited member accounts accept the handshake, you finalize the feature set\n change by accepting the handshake that contains \"Action\":\n \"ENABLE_ALL_FEATURES\". This completes the change.

\n

After you enable all features in your organization, the management account in the\n organization can apply policies on all member accounts. These policies can restrict what\n users and even administrators in those accounts can do. The management account can apply\n policies that prevent accounts from leaving the organization. Ensure that your account\n administrators are aware of this.

\n

You can only call this operation from the management account.

", "smithy.api#examples": [ { "title": "To enable all features in an organization", "documentation": "This example shows the administrator asking all the invited accounts in the organization to approve enabling all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to enable all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts:/n/n", "output": { "Handshake": { "Action": "ENABLE_ALL_FEATURES", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", "ExpirationTimestamp": "2017-02-28T09:35:40.05Z", "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" } ], "RequestedTimestamp": "2017-02-13T09:35:40.05Z", "Resources": [ { "Type": "ORGANIZATION", "Value": "o-exampleorgid" } ], "State": "REQUESTED" } } } ] } }, "com.amazonaws.organizations#EnableAllFeaturesRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#EnableAllFeaturesResponse": { "type": "structure", "members": { "Handshake": { "target": "com.amazonaws.organizations#Handshake", "traits": { "smithy.api#documentation": "

A structure that contains details about the handshake created to support this request\n to enable all features in the organization.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#EnablePolicyType": { "type": "operation", "input": { "target": "com.amazonaws.organizations#EnablePolicyTypeRequest" }, "output": { "target": "com.amazonaws.organizations#EnablePolicyTypeResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#PolicyChangesInProgressException" }, { "target": "com.amazonaws.organizations#PolicyTypeAlreadyEnabledException" }, { "target": "com.amazonaws.organizations#PolicyTypeNotAvailableForOrganizationException" }, { "target": "com.amazonaws.organizations#RootNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.

\n

This is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

\n

You can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n ListRoots.

", "smithy.api#examples": [ { "title": "To enable a policy type in a root", "documentation": "The following example shows how to enable the service control policy (SCP) policy type in a root. The output shows a root object with a PolicyTypes response element showing that SCPs are now enabled:/n/n", "input": { "RootId": "r-examplerootid111", "PolicyType": "SERVICE_CONTROL_POLICY" }, "output": { "Root": { "PolicyTypes": [ { "Status": "ENABLED", "Type": "SERVICE_CONTROL_POLICY" } ], "Name": "Root", "Id": "r-examplerootid111", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } } } ] } }, "com.amazonaws.organizations#EnablePolicyTypeRequest": { "type": "structure", "members": { "RootId": { "target": "com.amazonaws.organizations#RootId", "traits": { "smithy.api#documentation": "

ID for the root in which you want to enable a policy type. You can get the ID from the\n ListRoots operation.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.organizations#PolicyType", "traits": { "smithy.api#documentation": "

The policy type that you want to enable. You can specify one of the following\n values:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#EnablePolicyTypeResponse": { "type": "structure", "members": { "Root": { "target": "com.amazonaws.organizations#Root", "traits": { "smithy.api#documentation": "

A structure that shows the root with the updated list of enabled policy types.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#EnabledServicePrincipal": { "type": "structure", "members": { "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The name of the service principal. This is typically in the form of a URL, such as:\n \n servicename.amazonaws.com.

" } }, "DateEnabled": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The date that the service principal was enabled for integration with Organizations.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains details of a service principal that represents an Amazon Web Services\n service that is enabled to integrate with Organizations.

" } }, "com.amazonaws.organizations#EnabledServicePrincipals": { "type": "list", "member": { "target": "com.amazonaws.organizations#EnabledServicePrincipal" } }, "com.amazonaws.organizations#ErrorCode": { "type": "string" }, "com.amazonaws.organizations#ErrorMessage": { "type": "string" }, "com.amazonaws.organizations#ExceptionMessage": { "type": "string" }, "com.amazonaws.organizations#ExceptionType": { "type": "string" }, "com.amazonaws.organizations#FinalizingOrganizationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Organizations couldn't perform the operation because your organization hasn't finished\n initializing. This can take up to an hour. Try again later. If after one hour you\n continue to receive this error, contact Amazon Web Services Support.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#GenericArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:organizations::.+:.+$" } }, "com.amazonaws.organizations#Handshake": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { "smithy.api#documentation": "

ID for the handshake.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

" } }, "Arn": { "target": "com.amazonaws.organizations#HandshakeArn", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) for the handshake.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "Parties": { "target": "com.amazonaws.organizations#HandshakeParties", "traits": { "smithy.api#documentation": "

An array of HandshakeParty objects. Contains details for participant in a\n handshake.

" } }, "State": { "target": "com.amazonaws.organizations#HandshakeState", "traits": { "smithy.api#documentation": "

Current state for the handshake.

\n " } }, "RequestedTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp when the handshake request was made.

" } }, "ExpirationTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp when the handshake expires.

" } }, "Action": { "target": "com.amazonaws.organizations#ActionType", "traits": { "smithy.api#documentation": "

The type of handshake:

\n " } }, "Resources": { "target": "com.amazonaws.organizations#HandshakeResources", "traits": { "smithy.api#documentation": "

An array of HandshakeResource objects. When needed, contains additional\n details for a handshake. For example, the email address for the sender.

" } } }, "traits": { "smithy.api#documentation": "

Contains details for a handshake. A handshake is the secure exchange of information\n between two Amazon Web Services accounts: a sender and a recipient.

\n

\n Note: Handshakes that are CANCELED,\n ACCEPTED, DECLINED, or EXPIRED show up in\n lists for only 30 days after entering that state After that they are deleted.

" } }, "com.amazonaws.organizations#HandshakeAlreadyInStateException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified handshake is already in the requested state. For example, you can't\n accept a handshake that was already accepted.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#HandshakeArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:organizations::\\d{12}:handshake\\/o-[a-z0-9]{10,32}\\/[a-z_]{1,32}\\/h-[0-9a-z]{8,32}$" } }, "com.amazonaws.organizations#HandshakeConstraintViolationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" }, "Reason": { "target": "com.amazonaws.organizations#HandshakeConstraintViolationExceptionReason" } }, "traits": { "smithy.api#documentation": "

The requested operation would violate the constraint identified in the reason\n code.

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation:

\n
\n ", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#HandshakeConstraintViolationExceptionReason": { "type": "enum", "members": { "ACCOUNT_NUMBER_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_NUMBER_LIMIT_EXCEEDED" } }, "HANDSHAKE_RATE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HANDSHAKE_RATE_LIMIT_EXCEEDED" } }, "ALREADY_IN_AN_ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALREADY_IN_AN_ORGANIZATION" } }, "ORGANIZATION_ALREADY_HAS_ALL_FEATURES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_ALREADY_HAS_ALL_FEATURES" } }, "ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION" } }, "INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES" } }, "PAYMENT_INSTRUMENT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAYMENT_INSTRUMENT_REQUIRED" } }, "ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD" } }, "ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED" } }, "MANAGEMENT_ACCOUNT_EMAIL_NOT_VERIFIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGEMENT_ACCOUNT_EMAIL_NOT_VERIFIED" } }, "RESPONSIBILITY_TRANSFER_ALREADY_EXISTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSIBILITY_TRANSFER_ALREADY_EXISTS" } }, "SOURCE_AND_TARGET_CANNOT_MATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SOURCE_AND_TARGET_CANNOT_MATCH" } }, "UNUSED_PREPAYMENT_BALANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNUSED_PREPAYMENT_BALANCE" } }, "LEGACY_PERMISSIONS_STILL_IN_USE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LEGACY_PERMISSIONS_STILL_IN_USE" } }, "PAST_DUE_INVOICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PAST_DUE_INVOICE" } }, "TARGET_ACCOUNT_VALIDATION_FAILURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TARGET_ACCOUNT_VALIDATION_FAILURE" } } } }, "com.amazonaws.organizations#HandshakeFilter": { "type": "structure", "members": { "ActionType": { "target": "com.amazonaws.organizations#ActionType", "traits": { "smithy.api#documentation": "

The type of handshake.

\n

If you specify ActionType, you cannot also specify\n ParentHandshakeId.

" } }, "ParentHandshakeId": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { "smithy.api#documentation": "

The parent handshake. Only used for handshake types that are a child of another\n type.

\n

If you specify ParentHandshakeId, you cannot also specify\n ActionType.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

" } } }, "traits": { "smithy.api#documentation": "

Contains the filter used to select the handshakes for an operation.

" } }, "com.amazonaws.organizations#HandshakeId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 34 }, "smithy.api#pattern": "^h-[0-9a-z]{8,32}$" } }, "com.amazonaws.organizations#HandshakeNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a handshake with the HandshakeId that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#HandshakeNotes": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^[\\s\\S]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.organizations#HandshakeParties": { "type": "list", "member": { "target": "com.amazonaws.organizations#HandshakeParty" } }, "com.amazonaws.organizations#HandshakeParty": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#HandshakePartyId", "traits": { "smithy.api#documentation": "

ID for the participant: Acccount ID, organization ID, or email address.

\n

The regex pattern for handshake ID string requires \"h-\" \n followed by from 8 to 32 lowercase letters or digits.

", "smithy.api#required": {} } }, "Type": { "target": "com.amazonaws.organizations#HandshakePartyType", "traits": { "smithy.api#documentation": "

The type of ID for the participant.

\n \n

ORGANIZATION is valid only in the response context (identifying the inviting\n organization). Valid input values for the Target parameter are ACCOUNT and EMAIL\n only.

\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains details for a participant in a handshake.

" } }, "com.amazonaws.organizations#HandshakePartyId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[\\s\\S]*$", "smithy.api#sensitive": {} } }, "com.amazonaws.organizations#HandshakePartyType": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT" } }, "ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } } } }, "com.amazonaws.organizations#HandshakeResource": { "type": "structure", "members": { "Value": { "target": "com.amazonaws.organizations#HandshakeResourceValue", "traits": { "smithy.api#documentation": "

Additional information for the handshake. The format of the value string must match\n the requirements of the specified type.

" } }, "Type": { "target": "com.amazonaws.organizations#HandshakeResourceType", "traits": { "smithy.api#documentation": "

The type of information being passed, specifying how the value is to be interpreted by\n the other party:

\n " } }, "Resources": { "target": "com.amazonaws.organizations#HandshakeResources", "traits": { "smithy.api#documentation": "

An array of HandshakeResource objects. When needed, contains additional\n details for a handshake. For example, the email address for the sender.

" } } }, "traits": { "smithy.api#documentation": "

Contains additional details for a handshake.

" } }, "com.amazonaws.organizations#HandshakeResourceType": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT" } }, "ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION" } }, "ORGANIZATION_FEATURE_SET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_FEATURE_SET" } }, "EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EMAIL" } }, "MASTER_EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MASTER_EMAIL" } }, "MASTER_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MASTER_NAME" } }, "NOTES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOTES" } }, "PARENT_HANDSHAKE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARENT_HANDSHAKE" } }, "RESPONSIBILITY_TRANSFER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSIBILITY_TRANSFER" } }, "TRANSFER_START_TIMESTAMP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_START_TIMESTAMP" } }, "TRANSFER_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRANSFER_TYPE" } }, "MANAGEMENT_ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGEMENT_ACCOUNT" } }, "MANAGEMENT_EMAIL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGEMENT_EMAIL" } }, "MANAGEMENT_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANAGEMENT_NAME" } } } }, "com.amazonaws.organizations#HandshakeResourceValue": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.organizations#HandshakeResources": { "type": "list", "member": { "target": "com.amazonaws.organizations#HandshakeResource" } }, "com.amazonaws.organizations#HandshakeState": { "type": "enum", "members": { "REQUESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUESTED" } }, "OPEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPEN" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "DECLINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DECLINED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } } } }, "com.amazonaws.organizations#Handshakes": { "type": "list", "member": { "target": "com.amazonaws.organizations#Handshake" } }, "com.amazonaws.organizations#IAMUserAccessToBilling": { "type": "enum", "members": { "ALLOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALLOW" } }, "DENY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DENY" } } } }, "com.amazonaws.organizations#InvalidHandshakeTransitionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You can't perform the operation on the handshake in its current state. For example,\n you can't cancel a handshake that was already accepted or accept a handshake that was\n already declined.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#InvalidInputException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" }, "Reason": { "target": "com.amazonaws.organizations#InvalidInputExceptionReason" } }, "traits": { "smithy.api#documentation": "

The requested operation failed because you provided invalid values for one or more of\n the request parameters. This exception includes a reason that contains additional\n information about the violated limit:

\n \n

Some of the reasons in the following list might not be applicable to this specific\n API or operation.

\n
\n ", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.organizations#InvalidInputExceptionReason": { "type": "enum", "members": { "INVALID_PARTY_TYPE_TARGET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PARTY_TYPE_TARGET" } }, "INVALID_SYNTAX_ORGANIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SYNTAX_ORGANIZATION_ARN" } }, "INVALID_SYNTAX_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SYNTAX_POLICY_ID" } }, "INVALID_ENUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ENUM" } }, "INVALID_ENUM_POLICY_TYPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ENUM_POLICY_TYPE" } }, "INVALID_LIST_MEMBER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_LIST_MEMBER" } }, "MAX_LENGTH_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_LENGTH_EXCEEDED" } }, "MAX_VALUE_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_VALUE_EXCEEDED" } }, "MIN_LENGTH_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MIN_LENGTH_EXCEEDED" } }, "MIN_VALUE_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MIN_VALUE_EXCEEDED" } }, "IMMUTABLE_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMMUTABLE_POLICY" } }, "INVALID_PATTERN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PATTERN" } }, "INVALID_PATTERN_TARGET_ID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PATTERN_TARGET_ID" } }, "INPUT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INPUT_REQUIRED" } }, "INVALID_PAGINATION_TOKEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_NEXT_TOKEN" } }, "MAX_FILTER_LIMIT_EXCEEDED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MAX_LIMIT_EXCEEDED_FILTER" } }, "MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS" } }, "INVALID_FULL_NAME_TARGET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_FULL_NAME_TARGET" } }, "UNRECOGNIZED_SERVICE_PRINCIPAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNRECOGNIZED_SERVICE_PRINCIPAL" } }, "INVALID_ROLE_NAME": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_ROLE_NAME" } }, "INVALID_SYSTEM_TAGS_PARAMETER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_SYSTEM_TAGS_PARAMETER" } }, "DUPLICATE_TAG_KEY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DUPLICATE_TAG_KEY" } }, "TARGET_NOT_SUPPORTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TARGET_NOT_SUPPORTED" } }, "INVALID_EMAIL_ADDRESS_TARGET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_EMAIL_ADDRESS_TARGET" } }, "INVALID_RESOURCE_POLICY_JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_RESOURCE_POLICY_JSON" } }, "INVALID_PRINCIPAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_PRINCIPAL" } }, "UNSUPPORTED_ACTION_IN_RESOURCE_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_ACTION_IN_RESOURCE_POLICY" } }, "UNSUPPORTED_POLICY_TYPE_IN_RESOURCE_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_POLICY_TYPE_IN_RESOURCE_POLICY" } }, "UNSUPPORTED_RESOURCE_IN_RESOURCE_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_RESOURCE_IN_RESOURCE_POLICY" } }, "NON_DETACHABLE_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NON_DETACHABLE_POLICY" } }, "CALLER_REQUIRED_FIELD_MISSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CALLER_REQUIRED_FIELD_MISSING" } }, "UNSUPPORTED_ACTION_IN_RESPONSIBILITY_TRANSFER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSUPPORTED_ACTION_IN_RESPONSIBILITY_TRANSFER" } }, "START_DATE_NOT_BEGINNING_OF_MONTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "START_DATE_NOT_BEGINNING_OF_MONTH" } }, "START_DATE_NOT_BEGINNING_OF_DAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "START_DATE_NOT_BEGINNING_OF_DAY" } }, "START_DATE_TOO_EARLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "START_DATE_TOO_EARLY" } }, "START_DATE_TOO_LATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "START_DATE_TOO_LATE" } }, "INVALID_START_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_START_DATE" } }, "END_DATE_NOT_END_OF_MONTH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "END_DATE_NOT_END_OF_MONTH" } }, "END_DATE_TOO_EARLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "END_DATE_TOO_EARLY" } }, "END_DATE_TOO_LATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "END_DATE_TOO_LATE" } }, "INVALID_END_DATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INVALID_END_DATE" } } } }, "com.amazonaws.organizations#InvalidResponsibilityTransferTransitionException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The responsibility transfer can't transition to the requested state because it's not\n in a valid state for this operation.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#InviteAccountToOrganization": { "type": "operation", "input": { "target": "com.amazonaws.organizations#InviteAccountToOrganizationRequest" }, "output": { "target": "com.amazonaws.organizations#InviteAccountToOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountOwnerNotVerifiedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#DuplicateHandshakeException" }, { "target": "com.amazonaws.organizations#FinalizingOrganizationException" }, { "target": "com.amazonaws.organizations#HandshakeConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Sends an invitation to another account to join your organization as a member account.\n Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.

\n \n

If you receive an exception that indicates that you exceeded your account limits\n for the organization or that the operation failed because your organization is still\n initializing, wait one hour and then try again. If the error persists after an hour,\n contact Amazon Web Services\n Support.

\n
\n

If the request includes tags, then the requester must have the\n organizations:TagResource permission.

\n

You can only call this operation from the management account.

", "smithy.api#examples": [ { "title": "To invite an account to join an organization", "documentation": "The following example shows the admin of the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization.", "input": { "Notes": "This is a request for Juan's account to join Bill's organization", "Target": { "Type": "EMAIL", "Id": "juan@example.com" } }, "output": { "Handshake": { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": "2017-02-16T09:36:05.02Z", "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": "2017-02-01T09:36:05.02Z", "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" } } } ] } }, "com.amazonaws.organizations#InviteAccountToOrganizationRequest": { "type": "structure", "members": { "Target": { "target": "com.amazonaws.organizations#HandshakeParty", "traits": { "smithy.api#documentation": "

The identifier (ID) of the Amazon Web Services account that you want to invite to join your\n organization. This is a JSON object that contains the following elements:

\n

\n { \"Type\": \"ACCOUNT\", \"Id\": \"<\n account id\n number\n >\" }\n

\n

If you use the CLI, you can submit this as a single string, similar to the following\n example:

\n

\n --target Id=123456789012,Type=ACCOUNT\n

\n

If you specify \"Type\": \"ACCOUNT\", you must provide the Amazon Web Services account ID\n number as the Id. If you specify \"Type\": \"EMAIL\", you must\n specify the email address that is associated with the account.

\n

\n --target Id=diego@example.com,Type=EMAIL\n

", "smithy.api#required": {} } }, "Notes": { "target": "com.amazonaws.organizations#HandshakeNotes", "traits": { "smithy.api#documentation": "

Additional information that you want to include in the generated email to the\n recipient account owner.

" } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags that you want to attach to the account when it becomes a member of the\n organization. For each tag in the list, you must specify both a tag key and a value. You\n can set the value to an empty string, but you can't set it to null. For\n more information about tagging, see Tagging Organizations resources in the\n Organizations User Guide.

\n \n

Any tags in the request are checked for compliance with any applicable tag\n policies when the request is made. The request is rejected if the tags in the\n request don't match the requirements of the policy at that time. Tag policy\n compliance is \n not\n checked\n again when the invitation is accepted and the tags are actually attached to the\n account. That means that if the tag policy changes between the invitation and the\n acceptance, then that tags could potentially be non-compliant.

\n
\n \n

If any one of the tags is not valid or if you exceed the allowed number of tags\n for an account, then the entire request fails and invitations are not sent.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#InviteAccountToOrganizationResponse": { "type": "structure", "members": { "Handshake": { "target": "com.amazonaws.organizations#Handshake", "traits": { "smithy.api#documentation": "

A structure that contains details about the handshake that is created to support this\n invitation request.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#InviteOrganizationToTransferResponsibility": { "type": "operation", "input": { "target": "com.amazonaws.organizations#InviteOrganizationToTransferResponsibilityRequest" }, "output": { "target": "com.amazonaws.organizations#InviteOrganizationToTransferResponsibilityResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#DuplicateHandshakeException" }, { "target": "com.amazonaws.organizations#HandshakeConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Sends an invitation to another organization's management account to designate your\n account with the specified responsibilities for their organization. The invitation is\n implemented as a Handshake whose details are in the response.

\n

You can only call this operation from the management account.

" } }, "com.amazonaws.organizations#InviteOrganizationToTransferResponsibilityRequest": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.organizations#ResponsibilityTransferType", "traits": { "smithy.api#documentation": "

The type of responsibility you want to designate to your organization. Currently, only\n BILLING is supported.

", "smithy.api#required": {} } }, "Target": { "target": "com.amazonaws.organizations#HandshakeParty", "traits": { "smithy.api#documentation": "

A HandshakeParty object. Contains details for the account you want to\n invite. Currently, only ACCOUNT and EMAIL are supported.

", "smithy.api#required": {} } }, "Notes": { "target": "com.amazonaws.organizations#HandshakeNotes", "traits": { "smithy.api#documentation": "

Additional information that you want to include in the invitation.

" } }, "StartTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp when the recipient will begin managing the specified\n responsibilities.

", "smithy.api#required": {} } }, "SourceName": { "target": "com.amazonaws.organizations#ResponsibilityTransferName", "traits": { "smithy.api#documentation": "

Name you want to assign to the transfer.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags that you want to attach to the transfer. For each tag in the list, you must specify both a tag key and a value. You\n can set the value to an empty string, but you can't set it to null. For\n more information about tagging, see Tagging Organizations resources in the\n Organizations User Guide.

\n \n

Any tags in the request are checked for compliance with any applicable tag\n policies when the request is made. The request is rejected if the tags in the\n request don't match the requirements of the policy at that time. Tag policy\n compliance is \n not\n checked\n again when the invitation is accepted and the tags are actually attached to the\n transfer. That means that if the tag policy changes between the invitation and the\n acceptance, then that tags could potentially be non-compliant.

\n
\n \n

If any one of the tags is not valid or if you exceed the allowed number of tags\n for a transfer, then the entire request fails and invitations are not sent.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#InviteOrganizationToTransferResponsibilityResponse": { "type": "structure", "members": { "Handshake": { "target": "com.amazonaws.organizations#Handshake" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#LeaveOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#MasterCannotLeaveOrganizationException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the management account, use RemoveAccountFromOrganization\n instead.

\n

You can only call from operation from a member account.

\n

When an account leaves an organization, Organizations logs a membership event in\n CloudTrail. The event is an AccountDepartedOrganization event with\n departureMethod:LEFT and departureTime. This event is available\n only in the management account's event history.

\n \n \n ", "smithy.api#examples": [ { "title": "To leave an organization as a member account", "documentation": "TThe following example shows how to remove your member account from an organization:" } ] } }, "com.amazonaws.organizations#ListAWSServiceAccessForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListAWSServiceAccessForOrganizationRequest" }, "output": { "target": "com.amazonaws.organizations#ListAWSServiceAccessForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Returns a list of the Amazon Web Services services that you enabled to integrate with your\n organization. After a service on this list creates the resources that it requires for\n the integration, it can perform operations on your organization and its accounts.

\n

For more information about integrating other services with Organizations, including the\n list of services that currently work with Organizations, see Using Organizations with other Amazon Web Services\n services in the Organizations User Guide.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListAWSServiceAccessForOrganizationRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListAWSServiceAccessForOrganizationResponse": { "type": "structure", "members": { "EnabledServicePrincipals": { "target": "com.amazonaws.organizations#EnabledServicePrincipals", "traits": { "smithy.api#documentation": "

A list of the service principals for the services that are enabled to integrate with\n your organization. Each principal is a structure that includes the name and the date\n that it was enabled for integration with Organizations.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListAccounts": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListAccountsRequest" }, "output": { "target": "com.amazonaws.organizations#ListAccountsResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists all the accounts in the organization. To request only the accounts in a\n specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListAccountsForParent": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListAccountsForParentRequest" }, "output": { "target": "com.amazonaws.organizations#ListAccountsForParentResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ParentNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists the accounts in an organization that are contained by the specified target root\n or organizational unit (OU). If you specify the root, you get a list of all the accounts\n that aren't in any OU. If you specify an OU, you get a list of all the accounts in only\n that OU and not in any child OUs. To get a list of all accounts in the organization, use\n the ListAccounts operation.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To retrieve a list of all of the accounts in a root or OU", "documentation": "The following example shows how to request a list of the accounts in an OU:/n/n", "input": { "ParentId": "ou-examplerootid111-exampleouid111" }, "output": { "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" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListAccountsForParentRequest": { "type": "structure", "members": { "ParentId": { "target": "com.amazonaws.organizations#ParentId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) for the parent root or organization unit (OU) whose\n accounts you want to list.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListAccountsForParentResponse": { "type": "structure", "members": { "Accounts": { "target": "com.amazonaws.organizations#Accounts", "traits": { "smithy.api#documentation": "

A list of the accounts in the specified root or OU.

\n \n

The Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListAccountsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListAccountsResponse": { "type": "structure", "members": { "Accounts": { "target": "com.amazonaws.organizations#Accounts", "traits": { "smithy.api#documentation": "

A list of objects in the organization.

\n \n

The Status parameter in the API response will be retired on September 9, 2026.\n Although both the account State and account Status parameters are currently\n available in the Organizations APIs (DescribeAccount, ListAccounts,\n ListAccountsForParent), we recommend that you update your scripts or other code to\n use the State parameter instead of Status before September 9, 2026.

\n
" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyRequest" }, "output": { "target": "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#EffectivePolicyNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists all the accounts in an organization that have invalid effective policies. An\n invalid effective policy is an effective\n policy that fails validation checks, resulting in the effective policy not\n being fully enforced on all the intended accounts within an organization.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To list all accounts in an organization with invalid effective policy", "documentation": "The following example shows you how to request a list of the accounts in an organization having invalid effective policy for a policy type:", "input": { "PolicyType": "BACKUP_POLICY" }, "output": { "Accounts": [ { "Id": "111111111111", "Name": "Management Account", "Email": "bill@example.com" }, { "Id": "222222222222", "Name": "Developer Account", "Email": "alice@example.com" }, { "Id": "333333333333", "Name": "Test Account", "Email": "juan@example.com" }, { "Id": "444444444444", "Name": "Production Account", "Email": "anika@example.com" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Accounts", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyRequest": { "type": "structure", "members": { "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListAccountsWithInvalidEffectivePolicyResponse": { "type": "structure", "members": { "Accounts": { "target": "com.amazonaws.organizations#Accounts", "traits": { "smithy.api#documentation": "

The accounts in the organization which have an invalid effective policy for the specified policy type.

" } }, "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { "smithy.api#documentation": "

The specified policy type. One of the\n following values:

\n " } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListChildren": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListChildrenRequest" }, "output": { "target": "com.amazonaws.organizations#ListChildrenResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ParentNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists all of the organizational units (OUs) or accounts that are contained in the\n specified parent OU or root. This operation, along with ListParents\n enables you to traverse the tree structure that makes up this root.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To retrieve a list of all of the child accounts and OUs in a parent root or OU", "documentation": "The following example shows how to request a list of the child OUs in a parent root or OU:/n/n", "input": { "ChildType": "ORGANIZATIONAL_UNIT", "ParentId": "ou-examplerootid111-exampleouid111" }, "output": { "Children": [ { "Id": "ou-examplerootid111-exampleouid111", "Type": "ORGANIZATIONAL_UNIT" }, { "Id": "ou-examplerootid111-exampleouid222", "Type": "ORGANIZATIONAL_UNIT" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListChildrenRequest": { "type": "structure", "members": { "ParentId": { "target": "com.amazonaws.organizations#ParentId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) for the parent root or OU whose children you want to\n list.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n ", "smithy.api#required": {} } }, "ChildType": { "target": "com.amazonaws.organizations#ChildType", "traits": { "smithy.api#documentation": "

Filters the output to include only the specified child type.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListChildrenResponse": { "type": "structure", "members": { "Children": { "target": "com.amazonaws.organizations#Children", "traits": { "smithy.api#documentation": "

The list of children of the specified parent container.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListCreateAccountStatus": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListCreateAccountStatusRequest" }, "output": { "target": "com.amazonaws.organizations#ListCreateAccountStatusResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists the account creation requests that match the specified status that is currently\n being tracked for the organization.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To get a list of all account creation requests made in the organization", "documentation": "The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:", "input": { "States": [ "IN_PROGRESS" ] }, "output": { "CreateAccountStatuses": [ { "State": "IN_PROGRESS", "Id": "car-exampleaccountcreationrequestid2", "RequestedTimestamp": "2017-01-15T13:45:23.01Z", "AccountName": "Production Account" } ] } }, { "title": "To get a list of completed account creation requests made in the organization", "documentation": "The following example shows a user requesting a list of only the completed account creation requests made for the current organization:", "input": { "States": [ "SUCCEEDED" ] }, "output": { "CreateAccountStatuses": [ { "Id": "car-exampleaccountcreationrequestid1", "AccountId": "444444444444", "AccountName": "Developer Test Account", "RequestedTimestamp": "2017-01-15T13:45:23.01Z", "State": "SUCCEEDED", "CompletedTimestamp": "2017-01-15T13:45:23.6Z" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListCreateAccountStatusRequest": { "type": "structure", "members": { "States": { "target": "com.amazonaws.organizations#CreateAccountStates", "traits": { "smithy.api#documentation": "

A list of one or more states that you want included in the response. If this parameter\n isn't present, all requests are included in the response.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListCreateAccountStatusResponse": { "type": "structure", "members": { "CreateAccountStatuses": { "target": "com.amazonaws.organizations#CreateAccountStatuses", "traits": { "smithy.api#documentation": "

A list of objects with details about the requests. Certain elements, such as the\n accountId number, are present in the output only after the account has been successfully\n created.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListDelegatedAdministrators": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListDelegatedAdministratorsRequest" }, "output": { "target": "com.amazonaws.organizations#ListDelegatedAdministratorsResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists the Amazon Web Services accounts that are designated as delegated administrators in this\n organization.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "DelegatedAdministrators", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListDelegatedAdministratorsRequest": { "type": "structure", "members": { "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

Specifies a service principal name. If specified, then the operation lists the\n delegated administrators only for the specified service.

\n

If you don't specify a service principal, the operation lists all delegated\n administrators for all services in your organization.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListDelegatedAdministratorsResponse": { "type": "structure", "members": { "DelegatedAdministrators": { "target": "com.amazonaws.organizations#DelegatedAdministrators", "traits": { "smithy.api#documentation": "

The list of delegated administrators in your organization.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListDelegatedServicesForAccount": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListDelegatedServicesForAccountRequest" }, "output": { "target": "com.amazonaws.organizations#ListDelegatedServicesForAccountResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AccountNotRegisteredException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

List the Amazon Web Services services for which the specified account is a delegated\n administrator.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "DelegatedServices", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListDelegatedServicesForAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The account ID number of a delegated administrator account in the organization.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListDelegatedServicesForAccountResponse": { "type": "structure", "members": { "DelegatedServices": { "target": "com.amazonaws.organizations#DelegatedServices", "traits": { "smithy.api#documentation": "

The services for which the account is a delegated administrator.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListEffectivePolicyValidationErrors": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsRequest" }, "output": { "target": "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#EffectivePolicyNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists all the validation errors on an effective\n policy for a specified account and policy type.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "EffectivePolicyValidationErrors", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The ID of the account that you want details about. Specifying an organization root or\n organizational unit (OU) as the target is not supported.

", "smithy.api#required": {} } }, "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { "smithy.api#documentation": "

The type of policy that you want information about. You can specify one of the\n following values:

\n ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListEffectivePolicyValidationErrorsResponse": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The ID of the specified account.

" } }, "PolicyType": { "target": "com.amazonaws.organizations#EffectivePolicyType", "traits": { "smithy.api#documentation": "

The specified policy type. One of the following values:

\n " } }, "Path": { "target": "com.amazonaws.organizations#Path", "traits": { "smithy.api#documentation": "

The path in the organization where the specified account exists.

" } }, "EvaluationTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

The time when the latest effective policy was generated for the specified\n account.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } }, "EffectivePolicyValidationErrors": { "target": "com.amazonaws.organizations#EffectivePolicyValidationErrors", "traits": { "smithy.api#documentation": "

The EffectivePolicyValidationError object contains details about the\n validation errors that occurred when generating or enforcing an effective policy, such\n as which policies contributed to the error and location of the error.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListHandshakesForAccount": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListHandshakesForAccountRequest" }, "output": { "target": "com.amazonaws.organizations#ListHandshakesForAccountResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists the recent handshakes that you have received.

\n

You can view CANCELED, ACCEPTED, DECLINED, or\n EXPIRED handshakes in API responses for 30 days before they are\n deleted.

\n

You can call this operation from any account in a organization.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
", "smithy.api#examples": [ { "title": "To retrieve a list of the handshakes sent to an account", "documentation": "The following example shows you how to get a list of handshakes that are associated with the account of the credentials used to call the operation:", "output": { "Handshakes": [ { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": "2017-01-28T14:35:23.3Z", "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": "2017-01-13T14:35:23.3Z", "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" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListHandshakesForAccountRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.organizations#HandshakeFilter", "traits": { "smithy.api#documentation": "

A HandshakeFilter object. Contains the filer used to select the\n handshakes for an operation.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListHandshakesForAccountResponse": { "type": "structure", "members": { "Handshakes": { "target": "com.amazonaws.organizations#Handshakes", "traits": { "smithy.api#documentation": "

An array of Handshakeobjects. Contains details for a handshake.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListHandshakesForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListHandshakesForOrganizationRequest" }, "output": { "target": "com.amazonaws.organizations#ListHandshakesForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists the recent handshakes that you have sent.

\n

You can view CANCELED, ACCEPTED, DECLINED, or\n EXPIRED handshakes in API responses for 30 days before they are\n deleted.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
", "smithy.api#examples": [ { "title": "To retrieve a list of the handshakes associated with an organization", "documentation": "The following example shows you how to get a list of handshakes associated with the current organization:", "output": { "Handshakes": [ { "Action": "INVITE", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": "2017-01-28T14:35:23.3Z", "Id": "h-examplehandshakeid111", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "juan@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": "2017-01-13T14:35:23.3Z", "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" }, { "Action": "INVITE", "State": "ACCEPTED", "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", "ExpirationTimestamp": "2017-01-28T14:35:23.3Z", "Id": "h-examplehandshakeid222", "Parties": [ { "Id": "o-exampleorgid", "Type": "ORGANIZATION" }, { "Id": "anika@example.com", "Type": "EMAIL" } ], "RequestedTimestamp": "2017-01-13T14:35:23.3Z", "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." } ] } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListHandshakesForOrganizationRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.organizations#HandshakeFilter", "traits": { "smithy.api#documentation": "

A HandshakeFilter object. Contains the filer used to select the\n handshakes for an operation.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListHandshakesForOrganizationResponse": { "type": "structure", "members": { "Handshakes": { "target": "com.amazonaws.organizations#Handshakes", "traits": { "smithy.api#documentation": "

An array of Handshakeobjects. Contains details for a handshake.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListInboundResponsibilityTransfers": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListInboundResponsibilityTransfersRequest" }, "output": { "target": "com.amazonaws.organizations#ListInboundResponsibilityTransfersResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ResponsibilityTransferNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists transfers that allow you to manage the specified responsibilities for another\n organization. This operation returns both transfer invitations and transfers.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
" } }, "com.amazonaws.organizations#ListInboundResponsibilityTransfersRequest": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.organizations#ResponsibilityTransferType", "traits": { "smithy.api#documentation": "

The type of responsibility. Currently, only BILLING is supported.

", "smithy.api#required": {} } }, "Id": { "target": "com.amazonaws.organizations#ResponsibilityTransferId", "traits": { "smithy.api#documentation": "

ID for the transfer.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListInboundResponsibilityTransfersResponse": { "type": "structure", "members": { "ResponsibilityTransfers": { "target": "com.amazonaws.organizations#ResponsibilityTransfers", "traits": { "smithy.api#documentation": "

A ResponsibilityTransfers object. Contains details for a transfer.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListOrganizationalUnitsForParent": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListOrganizationalUnitsForParentRequest" }, "output": { "target": "com.amazonaws.organizations#ListOrganizationalUnitsForParentResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ParentNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists the organizational units (OUs) in a parent organizational unit or root.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To retrieve a list of all of the child OUs in a parent root or OU", "documentation": "The following example shows how to get a list of OUs in a specified root:/n/n", "input": { "ParentId": "r-examplerootid111" }, "output": { "OrganizationalUnits": [ { "Id": "ou-examplerootid111-exampleouid111", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid111", "Name": "Development" }, { "Id": "ou-examplerootid111-exampleouid222", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examlerootid111-exampleouid222", "Name": "Production" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListOrganizationalUnitsForParentRequest": { "type": "structure", "members": { "ParentId": { "target": "com.amazonaws.organizations#ParentId", "traits": { "smithy.api#documentation": "

ID for the root or OU whose child OUs you want to list.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListOrganizationalUnitsForParentResponse": { "type": "structure", "members": { "OrganizationalUnits": { "target": "com.amazonaws.organizations#OrganizationalUnits", "traits": { "smithy.api#documentation": "

A list of the OUs in the specified root or parent OU.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListOutboundResponsibilityTransfers": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListOutboundResponsibilityTransfersRequest" }, "output": { "target": "com.amazonaws.organizations#ListOutboundResponsibilityTransfersResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists transfers that allow an account outside your organization to manage the\n specified responsibilities for your organization. This operation returns both transfer\n invitations and transfers.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
" } }, "com.amazonaws.organizations#ListOutboundResponsibilityTransfersRequest": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.organizations#ResponsibilityTransferType", "traits": { "smithy.api#documentation": "

The type of responsibility. Currently, only BILLING is supported.

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListOutboundResponsibilityTransfersResponse": { "type": "structure", "members": { "ResponsibilityTransfers": { "target": "com.amazonaws.organizations#ResponsibilityTransfers", "traits": { "smithy.api#documentation": "

An array of ResponsibilityTransfer objects. Contains details for a\n transfer.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListParents": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListParentsRequest" }, "output": { "target": "com.amazonaws.organizations#ListParentsResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ChildNotFoundException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists the root or organizational units (OUs) that serve as the immediate parent of the\n specified child OU or account. This operation, along with ListChildren\n enables you to traverse the tree structure that makes up this root.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

\n \n

In the current release, a child can have only a single parent.

\n
", "smithy.api#examples": [ { "title": "To retrieve a list of all of the parents of a child OU or account", "documentation": "The following example shows how to list the root or OUs that contain account 444444444444:/n/n", "input": { "ChildId": "444444444444" }, "output": { "Parents": [ { "Id": "ou-examplerootid111-exampleouid111", "Type": "ORGANIZATIONAL_UNIT" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListParentsRequest": { "type": "structure", "members": { "ChildId": { "target": "com.amazonaws.organizations#ChildId", "traits": { "smithy.api#documentation": "

ID for the OU or account whose parent containers you want to list. Don't specify a\n root.

\n

The regex pattern for a child ID string requires one of the \n following:

\n ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListParentsResponse": { "type": "structure", "members": { "Parents": { "target": "com.amazonaws.organizations#Parents", "traits": { "smithy.api#documentation": "

A list of parents for the specified child account or OU.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListPolicies": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListPoliciesRequest" }, "output": { "target": "com.amazonaws.organizations#ListPoliciesResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Retrieves the list of all policies in an organization of a specified type.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To retrieve a list policies in the organization", "documentation": "The following example shows how to get a list of service control policies (SCPs):/n/n", "input": { "Filter": "SERVICE_CONTROL_POLICY" }, "output": { "Policies": [ { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllS3Actions", "AwsManaged": false, "Id": "p-examplepolicyid111", "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/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/o-exampleorgid/service_control_policy/p-examplepolicyid222", "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." }, { "Type": "SERVICE_CONTROL_POLICY", "AwsManaged": true, "Description": "Allows access to every operation", "Id": "p-FullAWSAccess", "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess", "Name": "FullAWSAccess" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListPoliciesForTarget": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListPoliciesForTargetRequest" }, "output": { "target": "com.amazonaws.organizations#ListPoliciesForTargetResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TargetNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists the policies that are directly attached to the specified target root,\n organizational unit (OU), or account. You must specify the policy type that you want\n included in the returned list.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To retrieve a list policies attached to a root, OU, or account", "documentation": "The following example shows how to get a list of all service control policies (SCPs) of the type specified by the Filter parameter, that are directly attached to an account. The returned list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy:/n/n", "input": { "Filter": "SERVICE_CONTROL_POLICY", "TargetId": "444444444444" }, "output": { "Policies": [ { "Type": "SERVICE_CONTROL_POLICY", "Name": "AllowAllEC2Actions", "AwsManaged": false, "Id": "p-examplepolicyid222", "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid222", "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListPoliciesForTargetRequest": { "type": "structure", "members": { "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { "smithy.api#documentation": "

ID for the root, organizational unit, or account whose policies you want to\n list.

\n

The regex pattern for a target ID string requires one of the \n following:

\n ", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.organizations#PolicyType", "traits": { "smithy.api#documentation": "

The type of policy that you want to include in the returned list. You must specify one\n of the following values:

\n ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListPoliciesForTargetResponse": { "type": "structure", "members": { "Policies": { "target": "com.amazonaws.organizations#Policies", "traits": { "smithy.api#documentation": "

The list of policies that match the criteria in the request.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListPoliciesRequest": { "type": "structure", "members": { "Filter": { "target": "com.amazonaws.organizations#PolicyType", "traits": { "smithy.api#documentation": "

Specifies the type of policy that you want to include in the response. You must\n specify one of the following values:

\n ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListPoliciesResponse": { "type": "structure", "members": { "Policies": { "target": "com.amazonaws.organizations#Policies", "traits": { "smithy.api#documentation": "

A list of policies that match the filter criteria in the request. The output list\n doesn't include the policy contents. To see the content for a policy, see DescribePolicy.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListRoots": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListRootsRequest" }, "output": { "target": "com.amazonaws.organizations#ListRootsResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists the roots that are defined in the current organization.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

\n \n

Policy types can be enabled and disabled in roots. This is distinct from whether\n they're available in the organization. When you enable all features, you make policy\n types available for use in that organization. Individual policy types can then be\n enabled and disabled in a root. To see the availability of a policy type in an\n organization, use DescribeOrganization.

\n
", "smithy.api#examples": [ { "title": "To retrieve a list of roots in the organization", "documentation": "The following example shows how to get the list of the roots in the current organization:/n/n", "output": { "Roots": [ { "Name": "Root", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", "Id": "r-examplerootid111", "PolicyTypes": [ { "Status": "ENABLED", "Type": "SERVICE_CONTROL_POLICY" } ] } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListRootsRequest": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListRootsResponse": { "type": "structure", "members": { "Roots": { "target": "com.amazonaws.organizations#Roots", "traits": { "smithy.api#documentation": "

A list of roots that are defined in an organization.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.organizations#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TargetNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Lists tags that are attached to the specified resource.

\n

You can attach tags to the following resources in Organizations.

\n \n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "Tags" } } }, "com.amazonaws.organizations#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.organizations#TaggableResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource with the tags to list.

\n

You can specify any of the following taggable resources.

\n ", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

The tags that are assigned to the resource.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#ListTargetsForPolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#ListTargetsForPolicyRequest" }, "output": { "target": "com.amazonaws.organizations#ListTargetsForPolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#PolicyNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Lists all the roots, organizational units (OUs), and accounts that the specified\n policy is attached to.

\n \n

When calling List* operations, always check the NextToken response parameter value, even if you receive an empty result set.\nThese operations can occasionally return an empty set of results even when more results are available.\nContinue making requests until NextToken returns null. A null NextToken value indicates that you have retrieved all available results.

\n
\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To retrieve a list of roots, OUs, and accounts to which a policy is attached", "documentation": "The following example shows how to get the list of roots, OUs, and accounts to which the specified policy is attached:/n/n", "input": { "PolicyId": "p-FullAWSAccess" }, "output": { "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" } ] } } ], "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.organizations#ListTargetsForPolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.organizations#PolicyId", "traits": { "smithy.api#documentation": "

ID for the policy whose attachments you want to know.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

The parameter for receiving additional results if you receive a \n NextToken response in a previous request. A NextToken response \n indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.

" } }, "MaxResults": { "target": "com.amazonaws.organizations#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ListTargetsForPolicyResponse": { "type": "structure", "members": { "Targets": { "target": "com.amazonaws.organizations#PolicyTargets", "traits": { "smithy.api#documentation": "

A list of structures, each of which contains details about one of the entities to\n which the specified policy is attached.

" } }, "NextToken": { "target": "com.amazonaws.organizations#NextToken", "traits": { "smithy.api#documentation": "

If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#MalformedPolicyDocumentException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The provided policy document doesn't meet the requirements of the specified policy\n type. For example, the syntax might be incorrect. For details about service control\n policy syntax, see SCP syntax in the\n Organizations User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.organizations#MasterCannotLeaveOrganizationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You can't remove a management account from an organization. If you want the management\n account to become a member account in another organization, you must first delete the\n current organization of the management account.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 20 } } }, "com.amazonaws.organizations#MoveAccount": { "type": "operation", "input": { "target": "com.amazonaws.organizations#MoveAccountRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#DestinationParentNotFoundException" }, { "target": "com.amazonaws.organizations#DuplicateAccountException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#SourceParentNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Moves an account from its current source parent root or organizational unit (OU) to\n the specified destination parent root or OU.

\n

You can only call this operation from the management account.

", "smithy.api#examples": [ { "title": "To move an OU or account to another OU or the root", "documentation": "The following example shows how to move a member account from the root to an OU:/n/n", "input": { "AccountId": "333333333333", "SourceParentId": "r-examplerootid111", "DestinationParentId": "ou-examplerootid111-exampleouid111" } } ] } }, "com.amazonaws.organizations#MoveAccountRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

ID for the account that you want to move.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

", "smithy.api#required": {} } }, "SourceParentId": { "target": "com.amazonaws.organizations#ParentId", "traits": { "smithy.api#documentation": "

ID for the root or organizational unit that you want to move the account from.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n ", "smithy.api#required": {} } }, "DestinationParentId": { "target": "com.amazonaws.organizations#ParentId", "traits": { "smithy.api#documentation": "

ID for the root or organizational unit that you want to move the account to.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n ", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 100000 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.organizations#Organization": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#OrganizationId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of an organization.

\n

The regex pattern for an organization ID string requires \"o-\" \n followed by from 10 to 32 lowercase letters or digits.

" } }, "Arn": { "target": "com.amazonaws.organizations#OrganizationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an organization.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "FeatureSet": { "target": "com.amazonaws.organizations#OrganizationFeatureSet", "traits": { "smithy.api#documentation": "

Specifies the functionality that currently is available to the organization. If set to\n \"ALL\", then all features are enabled and policies can be applied to accounts in the\n organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing\n functionality is available. For more information, see Enabling all features\n in your organization in the Organizations User Guide.

" } }, "MasterAccountArn": { "target": "com.amazonaws.organizations#AccountArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the account that is designated as the management\n account for the organization.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "MasterAccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the management account of an organization.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

" } }, "MasterAccountEmail": { "target": "com.amazonaws.organizations#Email", "traits": { "smithy.api#documentation": "

The email address that is associated with the Amazon Web Services account that is designated as the\n management account for the organization.

" } }, "AvailablePolicyTypes": { "target": "com.amazonaws.organizations#PolicyTypes", "traits": { "smithy.api#documentation": "\n

Do not use. This field is deprecated and doesn't provide complete information\n about the policies in your organization.

\n
\n

To determine the policies that are enabled and available for use in your organization,\n use the ListRoots operation instead.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about an organization. An organization is a collection of accounts\n that are centrally managed together using consolidated billing, organized hierarchically\n with organizational units (OUs), and controlled with policies .

" } }, "com.amazonaws.organizations#OrganizationArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}$" } }, "com.amazonaws.organizations#OrganizationFeatureSet": { "type": "enum", "members": { "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "CONSOLIDATED_BILLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONSOLIDATED_BILLING" } } } }, "com.amazonaws.organizations#OrganizationId": { "type": "string", "traits": { "smithy.api#pattern": "^o-[a-z0-9]{10,32}$" } }, "com.amazonaws.organizations#OrganizationNotEmptyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The organization isn't empty. To delete an organization, you must first remove all\n accounts except the management account.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#OrganizationalUnit": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) associated with this OU. The ID is unique to the\n organization only.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.

" } }, "Arn": { "target": "com.amazonaws.organizations#OrganizationalUnitArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of this OU.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "Name": { "target": "com.amazonaws.organizations#OrganizationalUnitName", "traits": { "smithy.api#documentation": "

The friendly name of this OU.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, "Path": { "target": "com.amazonaws.organizations#Path", "traits": { "smithy.api#documentation": "

The path in the organization where this OU exists.

" } } }, "traits": { "smithy.api#documentation": "

Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services\n accounts within a root of an organization. Policies that are attached to an OU apply to\n all accounts contained in that OU and in any child OUs.

" } }, "com.amazonaws.organizations#OrganizationalUnitArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$" } }, "com.amazonaws.organizations#OrganizationalUnitId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 68 }, "smithy.api#pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" } }, "com.amazonaws.organizations#OrganizationalUnitName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.organizations#OrganizationalUnitNotEmptyException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified OU is not empty. Move all accounts to another root or to other OUs,\n remove all child OUs, and try the operation again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#OrganizationalUnitNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find an OU with the OrganizationalUnitId that you\n specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#OrganizationalUnits": { "type": "list", "member": { "target": "com.amazonaws.organizations#OrganizationalUnit" } }, "com.amazonaws.organizations#Parent": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#ParentId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the parent entity.

\n

The regex pattern for a parent ID string requires one of the \n following:

\n " } }, "Type": { "target": "com.amazonaws.organizations#ParentType", "traits": { "smithy.api#documentation": "

The type of the parent entity.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about either a root or an organizational unit (OU) that can\n contain OUs or accounts in an organization.

" } }, "com.amazonaws.organizations#ParentId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 100 }, "smithy.api#pattern": "^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" } }, "com.amazonaws.organizations#ParentNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a root or OU with the ParentId that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#ParentType": { "type": "enum", "members": { "ROOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROOT" } }, "ORGANIZATIONAL_UNIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATIONAL_UNIT" } } } }, "com.amazonaws.organizations#Parents": { "type": "list", "member": { "target": "com.amazonaws.organizations#Parent" } }, "com.amazonaws.organizations#Path": { "type": "string", "traits": { "smithy.api#pattern": "^(o-[a-z0-9]{10,32}\\/r-[0-9a-z]{4,32}(\\/ou\\-[0-9a-z]{4,32}-[a-z0-9]{8,32})*(\\/\\d{12})*)\\/$" } }, "com.amazonaws.organizations#PathToError": { "type": "string" }, "com.amazonaws.organizations#Paths": { "type": "list", "member": { "target": "com.amazonaws.organizations#Path" } }, "com.amazonaws.organizations#Policies": { "type": "list", "member": { "target": "com.amazonaws.organizations#PolicySummary" } }, "com.amazonaws.organizations#Policy": { "type": "structure", "members": { "PolicySummary": { "target": "com.amazonaws.organizations#PolicySummary", "traits": { "smithy.api#documentation": "

A structure that contains additional details about the policy.

" } }, "Content": { "target": "com.amazonaws.organizations#PolicyContent", "traits": { "smithy.api#documentation": "

The text content of the policy.

" } } }, "traits": { "smithy.api#documentation": "

Contains rules to be applied to the affected accounts. Policies can be attached\n directly to accounts, or to roots and OUs to affect all accounts in those\n hierarchies.

" } }, "com.amazonaws.organizations#PolicyArn": { "type": "string", "traits": { "smithy.api#pattern": "^(arn:aws:organizations::\\d{12}:policy\\/o-[a-z0-9]{10,32}\\/[0-9a-z_]+\\/p-[0-9a-z]{10,32})|(arn:aws:organizations::aws:policy\\/[0-9a-z_]+\\/p-[0-9a-zA-Z_]{10,128})$" } }, "com.amazonaws.organizations#PolicyChangesInProgressException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Changes to the effective policy are in progress, and its contents can't be returned.\n Try the operation again later.

", "smithy.api#error": "client" } }, "com.amazonaws.organizations#PolicyContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.organizations#PolicyDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 512 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.organizations#PolicyId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 130 }, "smithy.api#pattern": "^p-[0-9a-zA-Z_]{8,128}$" } }, "com.amazonaws.organizations#PolicyIds": { "type": "list", "member": { "target": "com.amazonaws.organizations#PolicyId" } }, "com.amazonaws.organizations#PolicyInUseException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The policy is attached to one or more entities. You must detach it from all roots,\n OUs, and accounts before performing this operation.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#PolicyName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.organizations#PolicyNotAttachedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The policy isn't attached to the specified target in the specified root.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#PolicyNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a policy with the PolicyId that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#PolicySummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#PolicyId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the policy.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

" } }, "Arn": { "target": "com.amazonaws.organizations#PolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "Name": { "target": "com.amazonaws.organizations#PolicyName", "traits": { "smithy.api#documentation": "

The friendly name of the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, "Description": { "target": "com.amazonaws.organizations#PolicyDescription", "traits": { "smithy.api#documentation": "

The description of the policy.

" } }, "Type": { "target": "com.amazonaws.organizations#PolicyType", "traits": { "smithy.api#documentation": "

The type of policy.

" } }, "AwsManaged": { "target": "com.amazonaws.organizations#AwsManagedPolicy", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

A boolean value that indicates whether the specified policy is an Amazon Web Services managed\n policy. If true, then you can attach the policy to roots, OUs, or accounts, but you\n cannot edit it.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a policy, but does not include the content. To see the\n content of a policy, see DescribePolicy.

" } }, "com.amazonaws.organizations#PolicyTargetId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 100 }, "smithy.api#pattern": "^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" } }, "com.amazonaws.organizations#PolicyTargetSummary": { "type": "structure", "members": { "TargetId": { "target": "com.amazonaws.organizations#PolicyTargetId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the policy target.

\n

The regex pattern for a target ID string requires one of the \n following:

\n " } }, "Arn": { "target": "com.amazonaws.organizations#GenericArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the policy target.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "Name": { "target": "com.amazonaws.organizations#TargetName", "traits": { "smithy.api#documentation": "

The friendly name of the policy target.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, "Type": { "target": "com.amazonaws.organizations#TargetType", "traits": { "smithy.api#documentation": "

The type of the policy target.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a root, OU, or account that a policy is attached to.

" } }, "com.amazonaws.organizations#PolicyTargets": { "type": "list", "member": { "target": "com.amazonaws.organizations#PolicyTargetSummary" } }, "com.amazonaws.organizations#PolicyType": { "type": "enum", "members": { "SERVICE_CONTROL_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE_CONTROL_POLICY" } }, "RESOURCE_CONTROL_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_CONTROL_POLICY" } }, "TAG_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TAG_POLICY" } }, "BACKUP_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BACKUP_POLICY" } }, "AISERVICES_OPT_OUT_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AISERVICES_OPT_OUT_POLICY" } }, "CHATBOT_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CHATBOT_POLICY" } }, "DECLARATIVE_POLICY_EC2": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DECLARATIVE_POLICY_EC2" } }, "SECURITYHUB_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITYHUB_POLICY" } }, "SECURITYHUB_CSPM_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITYHUB_CSPM_POLICY" } }, "INSPECTOR_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INSPECTOR_POLICY" } }, "UPGRADE_ROLLOUT_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPGRADE_ROLLOUT_POLICY" } }, "BEDROCK_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BEDROCK_POLICY" } }, "S3_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "S3_POLICY" } }, "NETWORK_SECURITY_DIRECTOR_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NETWORK_SECURITY_DIRECTOR_POLICY" } }, "GUARDDUTY_POLICY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GUARDDUTY_POLICY" } } } }, "com.amazonaws.organizations#PolicyTypeAlreadyEnabledException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified policy type is already enabled in the specified root.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#PolicyTypeNotAvailableForOrganizationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You can't use the specified policy type with the feature set currently enabled for\n this organization. For example, you can enable SCPs only after you enable all features\n in the organization. For more information, see Managing\n Organizations policiesin the Organizations User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#PolicyTypeNotEnabledException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The specified policy type isn't currently enabled in this root. You can't attach\n policies of the specified type to entities in a root until you enable that type in the\n root. For more information, see Enabling all features\n in your organization in the Organizations User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#PolicyTypeStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "PENDING_ENABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ENABLE" } }, "PENDING_DISABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DISABLE" } } } }, "com.amazonaws.organizations#PolicyTypeSummary": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.organizations#PolicyType", "traits": { "smithy.api#documentation": "

The name of the policy type.

" } }, "Status": { "target": "com.amazonaws.organizations#PolicyTypeStatus", "traits": { "smithy.api#documentation": "

The status of the policy type as it relates to the associated root. To attach a policy\n of the specified type to a root or to an OU or account in that root, it must be\n available in the organization and enabled for that root.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a policy type and its status in the associated root.

" } }, "com.amazonaws.organizations#PolicyTypes": { "type": "list", "member": { "target": "com.amazonaws.organizations#PolicyTypeSummary" } }, "com.amazonaws.organizations#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#PutResourcePolicyRequest" }, "output": { "target": "com.amazonaws.organizations#PutResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Creates or updates a resource policy.

\n

You can only call this operation from the management account..

" } }, "com.amazonaws.organizations#PutResourcePolicyRequest": { "type": "structure", "members": { "Content": { "target": "com.amazonaws.organizations#ResourcePolicyContent", "traits": { "smithy.api#documentation": "

If provided, the new content for the resource policy. The text must be correctly\n formatted JSON that complies with the syntax for the resource policy's type. For more\n information, see SCP syntax in the\n Organizations User Guide.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags that you want to attach to the newly created resource policy. For each\n tag in the list, you must specify both a tag key and a value. You can set the value to\n an empty string, but you can't set it to null. For more information about\n tagging, see Tagging\n Organizations resources in the Organizations User Guide.

\n \n

Calls with tags apply to the initial creation of the resource policy, otherwise an\n exception is thrown. If any one of the tags is not valid or if you exceed the\n allowed number of tags for the resource policy, then the entire request fails and\n the resource policy is not created.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#PutResourcePolicyResponse": { "type": "structure", "members": { "ResourcePolicy": { "target": "com.amazonaws.organizations#ResourcePolicy", "traits": { "smithy.api#documentation": "

A structure that contains details about the resource policy.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#RegisterDelegatedAdministrator": { "type": "operation", "input": { "target": "com.amazonaws.organizations#RegisterDelegatedAdministratorRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountAlreadyRegisteredException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Enables the specified member account to administer the Organizations features of the specified\n Amazon Web Services service. It grants read-only access to Organizations service data. The account still\n requires IAM permissions to access and administer the Amazon Web Services service.

\n

You can run this action only for Amazon Web Services services that support this\n feature. For a current list of services that support it, see the column Supports \n Delegated Administrator in the table at Amazon Web Services Services that you can use with \n Organizations in the Organizations User Guide.\n

\n

You can only call this operation from the management account.

" } }, "com.amazonaws.organizations#RegisterDelegatedAdministratorRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

The account ID number of the member account in the organization to register as a\n delegated administrator.

", "smithy.api#required": {} } }, "ServicePrincipal": { "target": "com.amazonaws.organizations#ServicePrincipal", "traits": { "smithy.api#documentation": "

The service principal of the Amazon Web Services service for which you want to make the member\n account a delegated administrator.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#RemoveAccountFromOrganization": { "type": "operation", "input": { "target": "com.amazonaws.organizations#RemoveAccountFromOrganizationRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AccountNotFoundException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#MasterCannotLeaveOrganizationException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Removes the specified account from the organization.

\n

The removed account becomes a standalone account that isn't a member of any\n organization. It's no longer subject to any policies and is responsible for its own bill\n payments. The organization's management account is no longer charged for any expenses\n accrued by the member account after it's removed from the organization.

\n

You can only call this operation from the management account. Member accounts can remove themselves with LeaveOrganization instead.

\n

When an account is removed from an organization, Organizations logs a membership\n event in CloudTrail. The event is an\n AccountDepartedOrganization event with\n departureMethod:REMOVED and departureTime. This event is\n available only in the management account's event history.

\n \n \n ", "smithy.api#examples": [ { "title": "To remove an account from an organization as the master account", "documentation": "The following example shows you how to remove an account from an organization:", "input": { "AccountId": "333333333333" } } ] } }, "com.amazonaws.organizations#RemoveAccountFromOrganizationRequest": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

ID for the member account that you want to remove from the organization.

\n

The regex pattern for an account ID string requires exactly 12\n digits.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#ResourcePolicy": { "type": "structure", "members": { "ResourcePolicySummary": { "target": "com.amazonaws.organizations#ResourcePolicySummary", "traits": { "smithy.api#documentation": "

A structure that contains resource policy ID and Amazon Resource Name (ARN).

" } }, "Content": { "target": "com.amazonaws.organizations#ResourcePolicyContent", "traits": { "smithy.api#documentation": "

The policy text of the resource policy.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains details about a resource policy.

" } }, "com.amazonaws.organizations#ResourcePolicyArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\\d{12}:resourcepolicy\\/o-[a-z0-9]{10,32}\\/rp-[0-9a-zA-Z_]{4,128}$" } }, "com.amazonaws.organizations#ResourcePolicyContent": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 40000 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.organizations#ResourcePolicyId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 131 }, "smithy.api#pattern": "^rp-[0-9a-zA-Z_]{4,128}$" } }, "com.amazonaws.organizations#ResourcePolicyNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a resource policy request with the parameter that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#ResourcePolicySummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#ResourcePolicyId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) of the resource policy.

" } }, "Arn": { "target": "com.amazonaws.organizations#ResourcePolicyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource policy.

" } } }, "traits": { "smithy.api#documentation": "

A structure that contains resource policy ID and Amazon Resource Name (ARN).

" } }, "com.amazonaws.organizations#ResponsibilityTransfer": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.organizations#ResponsibilityTransferArn", "traits": { "smithy.api#documentation": "

Amazon Resource Name (ARN) for the transfer.

" } }, "Name": { "target": "com.amazonaws.organizations#ResponsibilityTransferName", "traits": { "smithy.api#documentation": "

Name assigned to the transfer.

" } }, "Id": { "target": "com.amazonaws.organizations#ResponsibilityTransferId", "traits": { "smithy.api#documentation": "

ID for the transfer.

" } }, "Type": { "target": "com.amazonaws.organizations#ResponsibilityTransferType", "traits": { "smithy.api#documentation": "

The type of transfer. Currently, only BILLING is supported.

" } }, "Status": { "target": "com.amazonaws.organizations#ResponsibilityTransferStatus", "traits": { "smithy.api#documentation": "

Status for the transfer.

" } }, "Source": { "target": "com.amazonaws.organizations#TransferParticipant", "traits": { "smithy.api#documentation": "

Account that allows another account external to its organization to manage the\n specified responsibilities for the organization.

" } }, "Target": { "target": "com.amazonaws.organizations#TransferParticipant", "traits": { "smithy.api#documentation": "

Account that manages the specified responsibilities for another organization.

" } }, "StartTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp when the transfer starts.

" } }, "EndTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp when the transfer ends.

" } }, "ActiveHandshakeId": { "target": "com.amazonaws.organizations#HandshakeId", "traits": { "smithy.api#documentation": "

ID for the handshake of the transfer.

" } } }, "traits": { "smithy.api#documentation": "

Contains details for a transfer. A transfer is the arrangement\n between two management accounts where one account designates the other with specified\n responsibilities for their organization.

" } }, "com.amazonaws.organizations#ResponsibilityTransferAlreadyInStatusException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

The responsibility transfer is already in the status that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.organizations#ResponsibilityTransferArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:[a-z0-9][a-z0-9-.]{0,62}:organizations::\\d{12}:transfer\\/o-[a-z0-9]{10,32}\\/(billing)\\/(inbound|outbound)\\/rt-[0-9a-z]{8,32}$" } }, "com.amazonaws.organizations#ResponsibilityTransferId": { "type": "string", "traits": { "smithy.api#pattern": "^rt-[0-9a-z]{8,32}$" } }, "com.amazonaws.organizations#ResponsibilityTransferName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[ -~]+$", "smithy.api#sensitive": {} } }, "com.amazonaws.organizations#ResponsibilityTransferNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a transfer that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#ResponsibilityTransferStatus": { "type": "enum", "members": { "REQUESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUESTED" } }, "DECLINED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DECLINED" } }, "CANCELED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANCELED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "WITHDRAWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WITHDRAWN" } } } }, "com.amazonaws.organizations#ResponsibilityTransferType": { "type": "enum", "members": { "BILLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING" } } } }, "com.amazonaws.organizations#ResponsibilityTransfers": { "type": "list", "member": { "target": "com.amazonaws.organizations#ResponsibilityTransfer" } }, "com.amazonaws.organizations#RoleName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 }, "smithy.api#pattern": "^[\\w+=,.@-]{1,64}$" } }, "com.amazonaws.organizations#Root": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#RootId", "traits": { "smithy.api#documentation": "

The unique identifier (ID) for the root. The ID is unique to the organization\n only.

\n

The regex pattern for a root ID string requires \"r-\" followed by \n from 4 to 32 lowercase letters or digits.

" } }, "Arn": { "target": "com.amazonaws.organizations#RootArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the root.

\n

For more information about ARNs in Organizations, see ARN \n Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

" } }, "Name": { "target": "com.amazonaws.organizations#RootName", "traits": { "smithy.api#documentation": "

The friendly name of the root.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, "PolicyTypes": { "target": "com.amazonaws.organizations#PolicyTypes", "traits": { "smithy.api#documentation": "

The types of policies that are currently enabled for the root and therefore can be\n attached to the root or to its OUs or accounts.

\n \n

Even if a policy type is shown as available in the organization, you can\n separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in\n that organization.

\n
" } } }, "traits": { "smithy.api#documentation": "

Contains details about a root. A root is a top-level parent node in the hierarchy of\n an organization that can contain organizational units (OUs) and accounts.\n The root contains every Amazon Web Services account in the\n organization.

" } }, "com.amazonaws.organizations#RootArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws:organizations::\\d{12}:root\\/o-[a-z0-9]{10,32}\\/r-[0-9a-z]{4,32}$" } }, "com.amazonaws.organizations#RootId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 34 }, "smithy.api#pattern": "^r-[0-9a-z]{4,32}$" } }, "com.amazonaws.organizations#RootName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.organizations#RootNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a root with the RootId that you specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#Roots": { "type": "list", "member": { "target": "com.amazonaws.organizations#Root" } }, "com.amazonaws.organizations#ServiceException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

Organizations can't complete your request because of an internal service error. Try again\n later.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.organizations#ServicePrincipal": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\w+=,.@-]*$" } }, "com.amazonaws.organizations#SourceParentNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a source root or OU with the ParentId that you\n specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.organizations#TagKey", "traits": { "smithy.api#documentation": "

The key identifier, or name, of the tag.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.organizations#TagValue", "traits": { "smithy.api#documentation": "

The string value that's associated with the key of the tag. You can set the value of a\n tag to an empty string, but you can't set the value of a tag to null.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A custom key-value pair associated with a resource within your organization.

\n

You can attach tags to any of the following organization resources.

\n " } }, "com.amazonaws.organizations#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.organizations#TagKeys": { "type": "list", "member": { "target": "com.amazonaws.organizations#TagKey" } }, "com.amazonaws.organizations#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.organizations#TagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TargetNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Adds one or more tags to the specified resource.

\n

Currently, you can attach tags to the following resources in Organizations.

\n \n

You can only call this operation from the management account or a member account that is a delegated administrator.

" } }, "com.amazonaws.organizations#TagResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.organizations#TaggableResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource to add a tag to.

\n

You can specify any of the following taggable resources.

\n ", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.organizations#Tags", "traits": { "smithy.api#documentation": "

A list of tags to add to the specified resource.

\n

For each tag in the list, you must specify both a tag key and a value. The value can\n be an empty string, but you can't set it to null.

\n \n

If any one of the tags is not valid or if you exceed the maximum allowed number of\n tags for a resource, then the entire request fails.

\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "com.amazonaws.organizations#TaggableResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 130 }, "smithy.api#pattern": "^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})|(^p-[0-9a-zA-Z_]{8,128})|(^rp-[0-9a-zA-Z_]{4,128})|(^rt-[0-9a-zA-Z_]{8,32})$" } }, "com.amazonaws.organizations#Tags": { "type": "list", "member": { "target": "com.amazonaws.organizations#Tag" } }, "com.amazonaws.organizations#TargetName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.organizations#TargetNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

We can't find a root, OU, account, or policy with the TargetId that you\n specified.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.organizations#TargetType": { "type": "enum", "members": { "ACCOUNT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT" } }, "ORGANIZATIONAL_UNIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATIONAL_UNIT" } }, "ROOT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROOT" } } } }, "com.amazonaws.organizations#TerminateResponsibilityTransfer": { "type": "operation", "input": { "target": "com.amazonaws.organizations#TerminateResponsibilityTransferRequest" }, "output": { "target": "com.amazonaws.organizations#TerminateResponsibilityTransferResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#InvalidResponsibilityTransferTransitionException" }, { "target": "com.amazonaws.organizations#ResponsibilityTransferAlreadyInStatusException" }, { "target": "com.amazonaws.organizations#ResponsibilityTransferNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Ends a transfer. A transfer is an arrangement between two\n management accounts where one account designates the other with specified\n responsibilities for their organization.

\n

When a transfer ends, Organizations publishes a\n ResponsibilityTransferTerminated service event to CloudTrail. Each affected\n account receives this event, including upstream participants such as distributors in a\n chained transfer. For an example log entry, see Example log entries: TerminateResponsibilityTransfer in the\n Organizations User Guide.

" } }, "com.amazonaws.organizations#TerminateResponsibilityTransferRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#ResponsibilityTransferId", "traits": { "smithy.api#documentation": "

ID for the transfer.

", "smithy.api#required": {} } }, "EndTimestamp": { "target": "com.amazonaws.organizations#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp when the responsibility transfer is to end.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#TerminateResponsibilityTransferResponse": { "type": "structure", "members": { "ResponsibilityTransfer": { "target": "com.amazonaws.organizations#ResponsibilityTransfer", "traits": { "smithy.api#documentation": "

A ResponsibilityTransfer object. Contains details for a transfer.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#Timestamp": { "type": "timestamp" }, "com.amazonaws.organizations#TooManyRequestsException": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.organizations#ExceptionType" }, "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

You have sent too many requests in too short a period of time. The quota helps protect\n against denial-of-service attacks. Try again later.

\n

For information about quotas that affect Organizations, see Quotas for Organizations in the\n Organizations User Guide.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.organizations#TransferParticipant": { "type": "structure", "members": { "ManagementAccountId": { "target": "com.amazonaws.organizations#AccountId", "traits": { "smithy.api#documentation": "

ID for the management account.

" } }, "ManagementAccountEmail": { "target": "com.amazonaws.organizations#Email", "traits": { "smithy.api#documentation": "

Email address for the management account.

" } } }, "traits": { "smithy.api#documentation": "

Contains details for a participant in a transfer. A transfer is\n the arrangement between two management accounts where one account designates the other\n with specified responsibilities for their organization.

" } }, "com.amazonaws.organizations#UnsupportedAPIEndpointException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.organizations#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "

This action isn't available in the current Amazon Web Services Region.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.organizations#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.organizations#UntagResourceRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TargetNotFoundException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Removes any tags with the specified keys from the specified resource.

\n

You can attach tags to the following resources in Organizations.

\n \n

You can only call this operation from the management account or a member account that is a delegated administrator.

" } }, "com.amazonaws.organizations#UntagResourceRequest": { "type": "structure", "members": { "ResourceId": { "target": "com.amazonaws.organizations#TaggableResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource to remove a tag from.

\n

You can specify any of the following taggable resources.

\n ", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.organizations#TagKeys", "traits": { "smithy.api#documentation": "

The list of keys for tags to remove from the specified resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#UpdateOrganizationalUnit": { "type": "operation", "input": { "target": "com.amazonaws.organizations#UpdateOrganizationalUnitRequest" }, "output": { "target": "com.amazonaws.organizations#UpdateOrganizationalUnitResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#DuplicateOrganizationalUnitException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#OrganizationalUnitNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" } ], "traits": { "smithy.api#documentation": "

Renames the specified organizational unit (OU). The ID and ARN don't change. The child\n OUs and accounts remain in place, and any attached policies of the OU remain\n attached.

\n

You can only call this operation from the management account.

", "smithy.api#examples": [ { "title": "To rename an organizational unit", "documentation": "The following example shows how to rename an OU. The output confirms the new name:/n/n", "input": { "OrganizationalUnitId": "ou-examplerootid111-exampleouid111", "Name": "AccountingOU" }, "output": { "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111", "Name": "AccountingOU", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111" } } } ] } }, "com.amazonaws.organizations#UpdateOrganizationalUnitRequest": { "type": "structure", "members": { "OrganizationalUnitId": { "target": "com.amazonaws.organizations#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

ID for the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.

\n

The regex pattern for an organizational unit ID string requires \n \"ou-\" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the \n OU). This string is followed by a second \"-\" dash and from 8 to 32 additional lowercase letters \n or digits.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.organizations#OrganizationalUnitName", "traits": { "smithy.api#documentation": "

The new name that you want to assign to the OU.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#UpdateOrganizationalUnitResponse": { "type": "structure", "members": { "OrganizationalUnit": { "target": "com.amazonaws.organizations#OrganizationalUnit", "traits": { "smithy.api#documentation": "

A structure that contains the details about the specified OU, including its new\n name.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#UpdatePolicy": { "type": "operation", "input": { "target": "com.amazonaws.organizations#UpdatePolicyRequest" }, "output": { "target": "com.amazonaws.organizations#UpdatePolicyResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConcurrentModificationException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#DuplicatePolicyException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#MalformedPolicyDocumentException" }, { "target": "com.amazonaws.organizations#PolicyChangesInProgressException" }, { "target": "com.amazonaws.organizations#PolicyNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Updates an existing policy with a new name, description, or content. If you don't\n supply any parameter, that value remains unchanged. You can't change a policy's\n type.

\n

You can only call this operation from the management account or a member account that is a delegated administrator.

", "smithy.api#examples": [ { "title": "To update the content of a policy", "documentation": "The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n", "input": { "PolicyId": "p-examplepolicyid111", "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }" }, "output": { "Policy": { "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", "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" } } } }, { "title": "To update the details of a policy", "documentation": "The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n", "input": { "PolicyId": "p-examplepolicyid111", "Name": "Renamed-Policy", "Description": "This description replaces the original." }, "output": { "Policy": { "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }", "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" } } } } ] } }, "com.amazonaws.organizations#UpdatePolicyRequest": { "type": "structure", "members": { "PolicyId": { "target": "com.amazonaws.organizations#PolicyId", "traits": { "smithy.api#documentation": "

ID for the policy that you want to update.

\n

The regex pattern for a policy ID string requires \"p-\" followed \n by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.organizations#PolicyName", "traits": { "smithy.api#documentation": "

If provided, the new name for the policy.

\n

The regex pattern \n that is used to validate this parameter is a string of any of the characters in the ASCII \n character range.

" } }, "Description": { "target": "com.amazonaws.organizations#PolicyDescription", "traits": { "smithy.api#documentation": "

If provided, the new description for the policy.

" } }, "Content": { "target": "com.amazonaws.organizations#PolicyContent", "traits": { "smithy.api#documentation": "

If provided, the new content for the policy. The text must be correctly formatted JSON\n that complies with the syntax for the policy's type. For more information, see SCP\n syntax in the Organizations User Guide.

\n

The maximum size of a policy document depends on the policy's type. For more\n information, see Maximum and minimum values in the\n Organizations User Guide.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#UpdatePolicyResponse": { "type": "structure", "members": { "Policy": { "target": "com.amazonaws.organizations#Policy", "traits": { "smithy.api#documentation": "

A structure that contains details about the updated policy, showing the requested\n changes.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.organizations#UpdateResponsibilityTransfer": { "type": "operation", "input": { "target": "com.amazonaws.organizations#UpdateResponsibilityTransferRequest" }, "output": { "target": "com.amazonaws.organizations#UpdateResponsibilityTransferResponse" }, "errors": [ { "target": "com.amazonaws.organizations#AccessDeniedException" }, { "target": "com.amazonaws.organizations#AWSOrganizationsNotInUseException" }, { "target": "com.amazonaws.organizations#ConstraintViolationException" }, { "target": "com.amazonaws.organizations#InvalidInputException" }, { "target": "com.amazonaws.organizations#ResponsibilityTransferNotFoundException" }, { "target": "com.amazonaws.organizations#ServiceException" }, { "target": "com.amazonaws.organizations#TooManyRequestsException" }, { "target": "com.amazonaws.organizations#UnsupportedAPIEndpointException" } ], "traits": { "smithy.api#documentation": "

Updates a transfer. A transfer is the arrangement between two\n management accounts where one account designates the other with specified\n responsibilities for their organization.

\n

You can update the name assigned to a transfer.

" } }, "com.amazonaws.organizations#UpdateResponsibilityTransferRequest": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.organizations#ResponsibilityTransferId", "traits": { "smithy.api#documentation": "

ID for the transfer.

", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.organizations#ResponsibilityTransferName", "traits": { "smithy.api#documentation": "

New name you want to assign to the transfer.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.organizations#UpdateResponsibilityTransferResponse": { "type": "structure", "members": { "ResponsibilityTransfer": { "target": "com.amazonaws.organizations#ResponsibilityTransfer" } }, "traits": { "smithy.api#output": {} } } } }