libZSservicesZSamazonka-organizationsZSamazonka-organizations
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Organizations.Lens

Description

 
Synopsis

Operations

ListHandshakesForAccount

listHandshakesForAccount_nextToken :: Lens' ListHandshakesForAccount (Maybe Text) Source #

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

listHandshakesForAccount_filter :: Lens' ListHandshakesForAccount (Maybe HandshakeFilter) Source #

Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.

listHandshakesForAccount_maxResults :: Lens' ListHandshakesForAccount (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listHandshakesForAccountResponse_handshakes :: Lens' ListHandshakesForAccountResponse (Maybe [Handshake]) Source #

A list of Handshake objects with details about each of the handshakes that is associated with the specified account.

listHandshakesForAccountResponse_nextToken :: Lens' ListHandshakesForAccountResponse (Maybe Text) Source #

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

DescribeAccount

describeAccount_accountId :: Lens' DescribeAccount Text Source #

The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

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

describeAccountResponse_account :: Lens' DescribeAccountResponse (Maybe Account) Source #

A structure that contains information about the requested account.

ListPolicies

listPolicies_nextToken :: Lens' ListPolicies (Maybe Text) Source #

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

listPolicies_maxResults :: Lens' ListPolicies (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listPolicies_filter :: Lens' ListPolicies PolicyType Source #

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

listPoliciesResponse_nextToken :: Lens' ListPoliciesResponse (Maybe Text) Source #

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

listPoliciesResponse_policies :: Lens' ListPoliciesResponse (Maybe [PolicySummary]) Source #

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

CreatePolicy

createPolicy_tags :: Lens' CreatePolicy (Maybe [Tag]) Source #

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

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

createPolicy_content :: Lens' CreatePolicy Text Source #

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

createPolicy_description :: Lens' CreatePolicy Text Source #

An optional description to assign to the policy.

createPolicy_name :: Lens' CreatePolicy Text Source #

The friendly name to assign to the policy.

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

createPolicy_type :: Lens' CreatePolicy PolicyType Source #

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

createPolicyResponse_policy :: Lens' CreatePolicyResponse (Maybe Policy) Source #

A structure that contains details about the newly created policy.

ListRoots

listRoots_nextToken :: Lens' ListRoots (Maybe Text) Source #

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

listRoots_maxResults :: Lens' ListRoots (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listRootsResponse_roots :: Lens' ListRootsResponse (Maybe [Root]) Source #

A list of roots that are defined in an organization.

listRootsResponse_nextToken :: Lens' ListRootsResponse (Maybe Text) Source #

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

listRootsResponse_httpStatus :: Lens' ListRootsResponse Int Source #

The response's http status code.

AcceptHandshake

acceptHandshake_handshakeId :: Lens' AcceptHandshake Text Source #

The unique identifier (ID) of the handshake that you want to accept.

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

acceptHandshakeResponse_handshake :: Lens' AcceptHandshakeResponse (Maybe Handshake) Source #

A structure that contains details about the accepted handshake.

CreateOrganization

createOrganization_featureSet :: Lens' CreateOrganization (Maybe OrganizationFeatureSet) Source #

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

  • CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the management account. For more information, see Consolidated billing in the AWS Organizations User Guide.

    The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.

  • ALL: In addition to all the features supported by the consolidated billing feature set, the management account can also apply any policy type to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.

createOrganizationResponse_organization :: Lens' CreateOrganizationResponse (Maybe Organization) Source #

A structure that contains details about the newly created organization.

EnableAllFeatures

enableAllFeaturesResponse_handshake :: Lens' EnableAllFeaturesResponse (Maybe Handshake) Source #

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

DeleteOrganization

DescribeHandshake

describeHandshake_handshakeId :: Lens' DescribeHandshake Text Source #

The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization.

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

describeHandshakeResponse_handshake :: Lens' DescribeHandshakeResponse (Maybe Handshake) Source #

A structure that contains information about the specified handshake.

ListTagsForResource

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

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

listTagsForResource_resourceId :: Lens' ListTagsForResource Text Source #

The ID of the resource with the tags to list.

You can specify any of the following taggable resources.

  • AWS account – specify the account ID number.
  • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
  • Root – specify the root ID that begins with r- and looks similar to: r-1a2b
  • Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

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

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

The tags that are assigned to the resource.

DescribePolicy

describePolicy_policyId :: Lens' DescribePolicy Text Source #

The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

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

describePolicyResponse_policy :: Lens' DescribePolicyResponse (Maybe Policy) Source #

A structure that contains details about the specified policy.

ListDelegatedServicesForAccount

listDelegatedServicesForAccount_nextToken :: Lens' ListDelegatedServicesForAccount (Maybe Text) Source #

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

listDelegatedServicesForAccount_maxResults :: Lens' ListDelegatedServicesForAccount (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listDelegatedServicesForAccount_accountId :: Lens' ListDelegatedServicesForAccount Text Source #

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

listDelegatedServicesForAccountResponse_nextToken :: Lens' ListDelegatedServicesForAccountResponse (Maybe Text) Source #

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

DisableAWSServiceAccess

disableAWSServiceAccess_servicePrincipal :: Lens' DisableAWSServiceAccess Text Source #

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

DescribeEffectivePolicy

describeEffectivePolicy_targetId :: Lens' DescribeEffectivePolicy (Maybe Text) Source #

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

describeEffectivePolicy_policyType :: Lens' DescribeEffectivePolicy EffectivePolicyType Source #

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

LeaveOrganization

MoveAccount

moveAccount_accountId :: Lens' MoveAccount Text Source #

The unique identifier (ID) of the account that you want to move.

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

moveAccount_sourceParentId :: Lens' MoveAccount Text Source #

The unique identifier (ID) of the root or organizational unit that you want to move the account from.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

moveAccount_destinationParentId :: Lens' MoveAccount Text Source #

The unique identifier (ID) of the root or organizational unit that you want to move the account to.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

ListAccounts

listAccounts_nextToken :: Lens' ListAccounts (Maybe Text) Source #

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

listAccounts_maxResults :: Lens' ListAccounts (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listAccountsResponse_accounts :: Lens' ListAccountsResponse (Maybe [Account]) Source #

A list of objects in the organization.

listAccountsResponse_nextToken :: Lens' ListAccountsResponse (Maybe Text) Source #

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

InviteAccountToOrganization

inviteAccountToOrganization_notes :: Lens' InviteAccountToOrganization (Maybe Text) Source #

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

inviteAccountToOrganization_tags :: Lens' InviteAccountToOrganization (Maybe [Tag]) Source #

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

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

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

inviteAccountToOrganization_target :: Lens' InviteAccountToOrganization HandshakeParty Source #

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

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

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

--target Id=123456789012,Type=ACCOUNT

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

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

inviteAccountToOrganizationResponse_handshake :: Lens' InviteAccountToOrganizationResponse (Maybe Handshake) Source #

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

ListAWSServiceAccessForOrganization

listAWSServiceAccessForOrganization_nextToken :: Lens' ListAWSServiceAccessForOrganization (Maybe Text) Source #

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

listAWSServiceAccessForOrganization_maxResults :: Lens' ListAWSServiceAccessForOrganization (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listAWSServiceAccessForOrganizationResponse_nextToken :: Lens' ListAWSServiceAccessForOrganizationResponse (Maybe Text) Source #

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

listAWSServiceAccessForOrganizationResponse_enabledServicePrincipals :: Lens' ListAWSServiceAccessForOrganizationResponse (Maybe [EnabledServicePrincipal]) Source #

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

ListOrganizationalUnitsForParent

listOrganizationalUnitsForParent_nextToken :: Lens' ListOrganizationalUnitsForParent (Maybe Text) Source #

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

listOrganizationalUnitsForParent_maxResults :: Lens' ListOrganizationalUnitsForParent (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listOrganizationalUnitsForParent_parentId :: Lens' ListOrganizationalUnitsForParent Text Source #

The unique identifier (ID) of the root or OU whose child OUs you want to list.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

listOrganizationalUnitsForParentResponse_nextToken :: Lens' ListOrganizationalUnitsForParentResponse (Maybe Text) Source #

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

CancelHandshake

cancelHandshake_handshakeId :: Lens' CancelHandshake Text Source #

The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.

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

cancelHandshakeResponse_handshake :: Lens' CancelHandshakeResponse (Maybe Handshake) Source #

A structure that contains details about the handshake that you canceled.

ListChildren

listChildren_nextToken :: Lens' ListChildren (Maybe Text) Source #

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

listChildren_maxResults :: Lens' ListChildren (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listChildren_parentId :: Lens' ListChildren Text Source #

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

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

listChildren_childType :: Lens' ListChildren ChildType Source #

Filters the output to include only the specified child type.

listChildrenResponse_children :: Lens' ListChildrenResponse (Maybe [Child]) Source #

The list of children of the specified parent container.

listChildrenResponse_nextToken :: Lens' ListChildrenResponse (Maybe Text) Source #

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

ListDelegatedAdministrators

listDelegatedAdministrators_servicePrincipal :: Lens' ListDelegatedAdministrators (Maybe Text) Source #

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

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

listDelegatedAdministrators_nextToken :: Lens' ListDelegatedAdministrators (Maybe Text) Source #

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

listDelegatedAdministrators_maxResults :: Lens' ListDelegatedAdministrators (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listDelegatedAdministratorsResponse_nextToken :: Lens' ListDelegatedAdministratorsResponse (Maybe Text) Source #

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

DeletePolicy

deletePolicy_policyId :: Lens' DeletePolicy Text Source #

The unique identifier (ID) of the policy that you want to delete. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

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

UpdatePolicy

updatePolicy_content :: Lens' UpdatePolicy (Maybe Text) Source #

If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide.

updatePolicy_name :: Lens' UpdatePolicy (Maybe Text) Source #

If provided, the new name for the policy.

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

updatePolicy_description :: Lens' UpdatePolicy (Maybe Text) Source #

If provided, the new description for the policy.

updatePolicy_policyId :: Lens' UpdatePolicy Text Source #

The unique identifier (ID) of the policy that you want to update.

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

updatePolicyResponse_policy :: Lens' UpdatePolicyResponse (Maybe Policy) Source #

A structure that contains details about the updated policy, showing the requested changes.

EnablePolicyType

enablePolicyType_rootId :: Lens' EnablePolicyType Text Source #

The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the ListRoots operation.

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

enablePolicyType_policyType :: Lens' EnablePolicyType PolicyType Source #

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

enablePolicyTypeResponse_root :: Lens' EnablePolicyTypeResponse (Maybe Root) Source #

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

DisablePolicyType

disablePolicyType_rootId :: Lens' DisablePolicyType Text Source #

The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.

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

disablePolicyType_policyType :: Lens' DisablePolicyType PolicyType Source #

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

disablePolicyTypeResponse_root :: Lens' DisablePolicyTypeResponse (Maybe Root) Source #

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

DescribeCreateAccountStatus

describeCreateAccountStatus_createAccountRequestId :: Lens' DescribeCreateAccountStatus Text Source #

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

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

describeCreateAccountStatusResponse_createAccountStatus :: Lens' DescribeCreateAccountStatusResponse (Maybe CreateAccountStatus) Source #

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

CreateOrganizationalUnit

createOrganizationalUnit_tags :: Lens' CreateOrganizationalUnit (Maybe [Tag]) Source #

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

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

createOrganizationalUnit_parentId :: Lens' CreateOrganizationalUnit Text Source #

The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

createOrganizationalUnit_name :: Lens' CreateOrganizationalUnit Text Source #

The friendly name to assign to the new OU.

ListAccountsForParent

listAccountsForParent_nextToken :: Lens' ListAccountsForParent (Maybe Text) Source #

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

listAccountsForParent_maxResults :: Lens' ListAccountsForParent (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listAccountsForParent_parentId :: Lens' ListAccountsForParent Text Source #

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

listAccountsForParentResponse_accounts :: Lens' ListAccountsForParentResponse (Maybe [Account]) Source #

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

listAccountsForParentResponse_nextToken :: Lens' ListAccountsForParentResponse (Maybe Text) Source #

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

DetachPolicy

detachPolicy_policyId :: Lens' DetachPolicy Text Source #

The unique identifier (ID) of the policy you want to detach. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

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

detachPolicy_targetId :: Lens' DetachPolicy Text Source #

The unique identifier (ID) of the root, OU, or account that you want to detach the policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Account - A string that consists of exactly 12 digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

RemoveAccountFromOrganization

removeAccountFromOrganization_accountId :: Lens' RemoveAccountFromOrganization Text Source #

The unique identifier (ID) of the member account that you want to remove from the organization.

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

CreateGovCloudAccount

createGovCloudAccount_iamUserAccessToBilling :: Lens' CreateGovCloudAccount (Maybe IAMUserAccessToBilling) Source #

If set to ALLOW, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

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

createGovCloudAccount_roleName :: Lens' CreateGovCloudAccount (Maybe Text) Source #

(Optional)

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

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

For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.

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

createGovCloudAccount_tags :: Lens' CreateGovCloudAccount (Maybe [Tag]) Source #

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

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

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

createGovCloudAccount_email :: Lens' CreateGovCloudAccount Text Source #

The email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount, the request for the email address for the AWS GovCloud (US) account originates from the commercial Region, not from the AWS GovCloud (US) Region.

createGovCloudAccount_accountName :: Lens' CreateGovCloudAccount Text Source #

The friendly name of the member account.

EnableAWSServiceAccess

enableAWSServiceAccess_servicePrincipal :: Lens' EnableAWSServiceAccess Text Source #

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

DescribeOrganizationalUnit

describeOrganizationalUnit_organizationalUnitId :: Lens' DescribeOrganizationalUnit Text Source #

The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent operation.

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

ListParents

listParents_nextToken :: Lens' ListParents (Maybe Text) Source #

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

listParents_maxResults :: Lens' ListParents (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listParents_childId :: Lens' ListParents Text Source #

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

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

  • Account - A string that consists of exactly 12 digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

listParentsResponse_nextToken :: Lens' ListParentsResponse (Maybe Text) Source #

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

listParentsResponse_parents :: Lens' ListParentsResponse (Maybe [Parent]) Source #

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

CreateAccount

createAccount_iamUserAccessToBilling :: Lens' CreateAccount (Maybe IAMUserAccessToBilling) Source #

If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

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

createAccount_roleName :: Lens' CreateAccount (Maybe Text) Source #

(Optional)

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

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

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

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

createAccount_tags :: Lens' CreateAccount (Maybe [Tag]) Source #

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

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

createAccount_email :: Lens' CreateAccount Text Source #

The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address.

createAccount_accountName :: Lens' CreateAccount Text Source #

The friendly name of the member account.

createAccountResponse_createAccountStatus :: Lens' CreateAccountResponse (Maybe CreateAccountStatus) Source #

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

DeregisterDelegatedAdministrator

deregisterDelegatedAdministrator_accountId :: Lens' DeregisterDelegatedAdministrator Text Source #

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

deregisterDelegatedAdministrator_servicePrincipal :: Lens' DeregisterDelegatedAdministrator Text Source #

The service principal name of an AWS service for which the account is a delegated administrator.

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

TagResource

tagResource_resourceId :: Lens' TagResource Text Source #

The ID of the resource to add a tag to.

tagResource_tags :: Lens' TagResource [Tag] Source #

A list of tags to add to the specified resource.

You can specify any of the following taggable resources.

  • AWS account – specify the account ID number.
  • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
  • Root – specify the root ID that begins with r- and looks similar to: r-1a2b
  • Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to null.

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

ListCreateAccountStatus

listCreateAccountStatus_states :: Lens' ListCreateAccountStatus (Maybe [CreateAccountState]) Source #

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

listCreateAccountStatus_nextToken :: Lens' ListCreateAccountStatus (Maybe Text) Source #

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

listCreateAccountStatus_maxResults :: Lens' ListCreateAccountStatus (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listCreateAccountStatusResponse_createAccountStatuses :: Lens' ListCreateAccountStatusResponse (Maybe [CreateAccountStatus]) Source #

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

listCreateAccountStatusResponse_nextToken :: Lens' ListCreateAccountStatusResponse (Maybe Text) Source #

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

ListTargetsForPolicy

listTargetsForPolicy_nextToken :: Lens' ListTargetsForPolicy (Maybe Text) Source #

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

listTargetsForPolicy_maxResults :: Lens' ListTargetsForPolicy (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listTargetsForPolicy_policyId :: Lens' ListTargetsForPolicy Text Source #

The unique identifier (ID) of the policy whose attachments you want to know.

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

listTargetsForPolicyResponse_nextToken :: Lens' ListTargetsForPolicyResponse (Maybe Text) Source #

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

listTargetsForPolicyResponse_targets :: Lens' ListTargetsForPolicyResponse (Maybe [PolicyTargetSummary]) Source #

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

DeclineHandshake

declineHandshake_handshakeId :: Lens' DeclineHandshake Text Source #

The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

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

declineHandshakeResponse_handshake :: Lens' DeclineHandshakeResponse (Maybe Handshake) Source #

A structure that contains details about the declined handshake. The state is updated to show the value DECLINED.

UntagResource

untagResource_resourceId :: Lens' UntagResource Text Source #

The ID of the resource to remove a tag from.

You can specify any of the following taggable resources.

  • AWS account – specify the account ID number.
  • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz
  • Root – specify the root ID that begins with r- and looks similar to: r-1a2b
  • Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The list of keys for tags to remove from the specified resource.

AttachPolicy

attachPolicy_policyId :: Lens' AttachPolicy Text Source #

The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.

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

attachPolicy_targetId :: Lens' AttachPolicy Text Source #

The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Account - A string that consists of exactly 12 digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

ListPoliciesForTarget

listPoliciesForTarget_nextToken :: Lens' ListPoliciesForTarget (Maybe Text) Source #

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

listPoliciesForTarget_maxResults :: Lens' ListPoliciesForTarget (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listPoliciesForTarget_targetId :: Lens' ListPoliciesForTarget Text Source #

The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Account - A string that consists of exactly 12 digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

listPoliciesForTarget_filter :: Lens' ListPoliciesForTarget PolicyType Source #

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

listPoliciesForTargetResponse_nextToken :: Lens' ListPoliciesForTargetResponse (Maybe Text) Source #

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

listPoliciesForTargetResponse_policies :: Lens' ListPoliciesForTargetResponse (Maybe [PolicySummary]) Source #

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

DescribeOrganization

describeOrganizationResponse_organization :: Lens' DescribeOrganizationResponse (Maybe Organization) Source #

A structure that contains information about the organization.

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

ListHandshakesForOrganization

listHandshakesForOrganization_nextToken :: Lens' ListHandshakesForOrganization (Maybe Text) Source #

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

listHandshakesForOrganization_filter :: Lens' ListHandshakesForOrganization (Maybe HandshakeFilter) Source #

A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.

listHandshakesForOrganization_maxResults :: Lens' ListHandshakesForOrganization (Maybe Natural) Source #

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

listHandshakesForOrganizationResponse_handshakes :: Lens' ListHandshakesForOrganizationResponse (Maybe [Handshake]) Source #

A list of Handshake objects with details about each of the handshakes that are associated with an organization.

listHandshakesForOrganizationResponse_nextToken :: Lens' ListHandshakesForOrganizationResponse (Maybe Text) Source #

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

RegisterDelegatedAdministrator

registerDelegatedAdministrator_accountId :: Lens' RegisterDelegatedAdministrator Text Source #

The account ID number of the member account in the organization to register as a delegated administrator.

registerDelegatedAdministrator_servicePrincipal :: Lens' RegisterDelegatedAdministrator Text Source #

The service principal of the AWS service for which you want to make the member account a delegated administrator.

DeleteOrganizationalUnit

deleteOrganizationalUnit_organizationalUnitId :: Lens' DeleteOrganizationalUnit Text Source #

The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation.

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

UpdateOrganizationalUnit

updateOrganizationalUnit_name :: Lens' UpdateOrganizationalUnit (Maybe Text) Source #

The new name that you want to assign to the OU.

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

updateOrganizationalUnit_organizationalUnitId :: Lens' UpdateOrganizationalUnit Text Source #

The unique identifier (ID) of the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.

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

updateOrganizationalUnitResponse_organizationalUnit :: Lens' UpdateOrganizationalUnitResponse (Maybe OrganizationalUnit) Source #

A structure that contains the details about the specified OU, including its new name.

Types

Account

account_status :: Lens' Account (Maybe AccountStatus) Source #

The status of the account in the organization.

account_joinedMethod :: Lens' Account (Maybe AccountJoinedMethod) Source #

The method by which the account joined the organization.

account_email :: Lens' Account (Maybe Text) Source #

The email address associated with the AWS account.

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

account_arn :: Lens' Account (Maybe Text) Source #

The Amazon Resource Name (ARN) of the account.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

account_joinedTimestamp :: Lens' Account (Maybe UTCTime) Source #

The date the account became a part of the organization.

account_name :: Lens' Account (Maybe Text) Source #

The friendly name of the account.

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

account_id :: Lens' Account (Maybe Text) Source #

The unique identifier (ID) of the account.

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

Child

child_id :: Lens' Child (Maybe Text) Source #

The unique identifier (ID) of this child entity.

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

  • Account - A string that consists of exactly 12 digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

child_type :: Lens' Child (Maybe ChildType) Source #

The type of this child entity.

CreateAccountStatus

createAccountStatus_failureReason :: Lens' CreateAccountStatus (Maybe CreateAccountFailureReason) Source #

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

  • ACCOUNT_LIMIT_EXCEEDED: The account couldn't be created because you reached the limit on the number of accounts in your organization.
  • CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information.
  • EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.
  • FAILED_BUSINESS_VALIDATION: The AWS account that owns your organization failed to receive business license validation.
  • GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.
  • IDENTITY_INVALID_BUSINESS_VALIDATION: The AWS account that owns your organization can't complete business license validation because it doesn't have valid identity data.
  • INVALID_ADDRESS: The account could not be created because the address you provided is not valid.
  • INVALID_EMAIL: The account could not be created because the email address you provided is not valid.
  • INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact AWS Customer Support.
  • MISSING_BUSINESS_VALIDATION: The AWS account that owns your organization has not received Business Validation.
  • MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card.
  • PENDING_BUSINESS_VALIDATION: The AWS account that owns your organization is still in the process of completing business license validation.
  • UNKNOWN_BUSINESS_VALIDATION: The AWS account that owns your organization has an unknown issue with business license validation.

createAccountStatus_state :: Lens' CreateAccountStatus (Maybe CreateAccountState) Source #

The status of the asynchronous request to create an AWS account.

createAccountStatus_completedTimestamp :: Lens' CreateAccountStatus (Maybe UTCTime) Source #

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

createAccountStatus_accountName :: Lens' CreateAccountStatus (Maybe Text) Source #

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

createAccountStatus_accountId :: Lens' CreateAccountStatus (Maybe Text) Source #

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

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

createAccountStatus_id :: Lens' CreateAccountStatus (Maybe Text) Source #

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

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

createAccountStatus_govCloudAccountId :: Lens' CreateAccountStatus (Maybe Text) Source #

If the account was created successfully, the unique identifier (ID) of the new account in the AWS GovCloud (US) Region.

createAccountStatus_requestedTimestamp :: Lens' CreateAccountStatus (Maybe UTCTime) Source #

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

DelegatedAdministrator

delegatedAdministrator_status :: Lens' DelegatedAdministrator (Maybe AccountStatus) Source #

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

delegatedAdministrator_joinedMethod :: Lens' DelegatedAdministrator (Maybe AccountJoinedMethod) Source #

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

delegatedAdministrator_email :: Lens' DelegatedAdministrator (Maybe Text) Source #

The email address that is associated with the delegated administrator's AWS account.

delegatedAdministrator_arn :: Lens' DelegatedAdministrator (Maybe Text) Source #

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

delegatedAdministrator_joinedTimestamp :: Lens' DelegatedAdministrator (Maybe UTCTime) Source #

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

delegatedAdministrator_delegationEnabledDate :: Lens' DelegatedAdministrator (Maybe UTCTime) Source #

The date when the account was made a delegated administrator.

delegatedAdministrator_name :: Lens' DelegatedAdministrator (Maybe Text) Source #

The friendly name of the delegated administrator's account.

delegatedAdministrator_id :: Lens' DelegatedAdministrator (Maybe Text) Source #

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

DelegatedService

delegatedService_servicePrincipal :: Lens' DelegatedService (Maybe Text) Source #

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

delegatedService_delegationEnabledDate :: Lens' DelegatedService (Maybe UTCTime) Source #

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

EffectivePolicy

effectivePolicy_targetId :: Lens' EffectivePolicy (Maybe Text) Source #

The account ID of the policy target.

effectivePolicy_lastUpdatedTimestamp :: Lens' EffectivePolicy (Maybe UTCTime) Source #

The time of the last update to this policy.

EnabledServicePrincipal

enabledServicePrincipal_servicePrincipal :: Lens' EnabledServicePrincipal (Maybe Text) Source #

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

enabledServicePrincipal_dateEnabled :: Lens' EnabledServicePrincipal (Maybe UTCTime) Source #

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

Handshake

handshake_state :: Lens' Handshake (Maybe HandshakeState) Source #

The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

  • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
  • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
  • CANCELED: This handshake is no longer active because it was canceled by the originating account.
  • ACCEPTED: This handshake is complete because it has been accepted by the recipient.
  • DECLINED: This handshake is no longer active because it was declined by the recipient account.
  • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

handshake_arn :: Lens' Handshake (Maybe Text) Source #

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

handshake_action :: Lens' Handshake (Maybe ActionType) Source #

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.
  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.
  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

handshake_resources :: Lens' Handshake (Maybe [HandshakeResource]) Source #

Additional information that is needed to process the handshake.

handshake_id :: Lens' Handshake (Maybe Text) Source #

The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

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

handshake_expirationTimestamp :: Lens' Handshake (Maybe UTCTime) Source #

The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

handshake_parties :: Lens' Handshake (Maybe [HandshakeParty]) Source #

Information about the two accounts that are participating in the handshake.

handshake_requestedTimestamp :: Lens' Handshake (Maybe UTCTime) Source #

The date and time that the handshake request was made.

HandshakeFilter

handshakeFilter_parentHandshakeId :: Lens' HandshakeFilter (Maybe Text) Source #

Specifies the parent handshake. Only used for handshake types that are a child of another type.

If you specify ParentHandshakeId, you cannot also specify ActionType.

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

handshakeFilter_actionType :: Lens' HandshakeFilter (Maybe ActionType) Source #

Specifies the type of handshake action.

If you specify ActionType, you cannot also specify ParentHandshakeId.

HandshakeParty

handshakeParty_id :: Lens' HandshakeParty Text Source #

The unique identifier (ID) for the party.

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

HandshakeResource

handshakeResource_value :: Lens' HandshakeResource (Maybe Text) Source #

The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

handshakeResource_resources :: Lens' HandshakeResource (Maybe [HandshakeResource]) Source #

When needed, contains an additional array of HandshakeResource objects.

handshakeResource_type :: Lens' HandshakeResource (Maybe HandshakeResourceType) Source #

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

  • ACCOUNT - Specifies an AWS account ID number.
  • ORGANIZATION - Specifies an organization ID number.
  • EMAIL - Specifies the email address that is associated with the account that receives the handshake.
  • OWNER_EMAIL - Specifies the email address associated with the management account. Included as information about an organization.
  • OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.
  • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

Organization

organization_arn :: Lens' Organization (Maybe Text) Source #

The Amazon Resource Name (ARN) of an organization.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

organization_masterAccountId :: Lens' Organization (Maybe Text) Source #

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

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

organization_masterAccountArn :: Lens' Organization (Maybe Text) Source #

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

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

organization_masterAccountEmail :: Lens' Organization (Maybe Text) Source #

The email address that is associated with the AWS account that is designated as the management account for the organization.

organization_availablePolicyTypes :: Lens' Organization (Maybe [PolicyTypeSummary]) Source #

Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.

To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.

organization_id :: Lens' Organization (Maybe Text) Source #

The unique identifier (ID) of an organization.

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

organization_featureSet :: Lens' Organization (Maybe OrganizationFeatureSet) Source #

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

OrganizationalUnit

organizationalUnit_arn :: Lens' OrganizationalUnit (Maybe Text) Source #

The Amazon Resource Name (ARN) of this OU.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

organizationalUnit_name :: Lens' OrganizationalUnit (Maybe Text) Source #

The friendly name of this OU.

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

organizationalUnit_id :: Lens' OrganizationalUnit (Maybe Text) Source #

The unique identifier (ID) associated with this OU.

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

Parent

parent_id :: Lens' Parent (Maybe Text) Source #

The unique identifier (ID) of the parent entity.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

parent_type :: Lens' Parent (Maybe ParentType) Source #

The type of the parent entity.

Policy

policy_content :: Lens' Policy (Maybe Text) Source #

The text content of the policy.

policy_policySummary :: Lens' Policy (Maybe PolicySummary) Source #

A structure that contains additional details about the policy.

PolicySummary

policySummary_arn :: Lens' PolicySummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the policy.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

policySummary_name :: Lens' PolicySummary (Maybe Text) Source #

The friendly name of the policy.

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

policySummary_id :: Lens' PolicySummary (Maybe Text) Source #

The unique identifier (ID) of the policy.

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

policySummary_awsManaged :: Lens' PolicySummary (Maybe Bool) Source #

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

policySummary_description :: Lens' PolicySummary (Maybe Text) Source #

The description of the policy.

PolicyTargetSummary

policyTargetSummary_targetId :: Lens' PolicyTargetSummary (Maybe Text) Source #

The unique identifier (ID) of the policy target.

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

  • Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
  • Account - A string that consists of exactly 12 digits.
  • Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

policyTargetSummary_arn :: Lens' PolicyTargetSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the policy target.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

policyTargetSummary_name :: Lens' PolicyTargetSummary (Maybe Text) Source #

The friendly name of the policy target.

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

PolicyTypeSummary

policyTypeSummary_status :: Lens' PolicyTypeSummary (Maybe PolicyTypeStatus) Source #

The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

Root

root_arn :: Lens' Root (Maybe Text) Source #

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

root_name :: Lens' Root (Maybe Text) Source #

The friendly name of the root.

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

root_id :: Lens' Root (Maybe Text) Source #

The unique identifier (ID) for the root.

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

root_policyTypes :: Lens' Root (Maybe [PolicyTypeSummary]) Source #

The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Even if a policy type is shown as available in the organization, you can 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 that organization.

Tag

tag_key :: Lens' Tag Text Source #

The key identifier, or name, of the tag.

tag_value :: Lens' Tag Text Source #

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.