Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- PolicyNotFoundException
- PolicyTypeAlreadyEnabledException
- HandshakeConstraintViolationException
- AccessDeniedException
- MalformedPolicyDocumentException
- RootNotFoundException
- MasterCannotLeaveOrganizationException
- AccountNotFoundException
- AccountAlreadyRegisteredException
- DuplicatePolicyException
- ConstraintViolationException
- AccountNotRegisteredException
- FinalizingOrganizationException
- HandshakeNotFoundException
- PolicyTypeNotAvailableForOrganizationException
- ChildNotFoundException
- UnsupportedAPIEndpointException
- EffectivePolicyNotFoundException
- OrganizationalUnitNotFoundException
- DestinationParentNotFoundException
- OrganizationNotEmptyException
- AccountOwnerNotVerifiedException
- PolicyTypeNotEnabledException
- DuplicateHandshakeException
- OrganizationalUnitNotEmptyException
- TooManyRequestsException
- ConcurrentModificationException
- ServiceException
- SourceParentNotFoundException
- TargetNotFoundException
- CreateAccountStatusNotFoundException
- AlreadyInOrganizationException
- DuplicateOrganizationalUnitException
- InvalidInputException
- PolicyChangesInProgressException
- PolicyNotAttachedException
- ParentNotFoundException
- AccessDeniedForDependencyException
- AWSOrganizationsNotInUseException
- PolicyInUseException
- InvalidHandshakeTransitionException
- HandshakeAlreadyInStateException
- DuplicateAccountException
- DuplicatePolicyAttachmentException
- Waiters
- Operations
- ListHandshakesForAccount (Paginated)
- DescribeAccount
- ListPolicies (Paginated)
- CreatePolicy
- ListRoots (Paginated)
- AcceptHandshake
- CreateOrganization
- EnableAllFeatures
- DeleteOrganization
- DescribeHandshake
- ListTagsForResource (Paginated)
- DescribePolicy
- ListDelegatedServicesForAccount (Paginated)
- DisableAWSServiceAccess
- DescribeEffectivePolicy
- LeaveOrganization
- MoveAccount
- ListAccounts (Paginated)
- InviteAccountToOrganization
- ListAWSServiceAccessForOrganization (Paginated)
- ListOrganizationalUnitsForParent (Paginated)
- CancelHandshake
- ListChildren (Paginated)
- ListDelegatedAdministrators (Paginated)
- DeletePolicy
- UpdatePolicy
- EnablePolicyType
- DisablePolicyType
- DescribeCreateAccountStatus
- CreateOrganizationalUnit
- ListAccountsForParent (Paginated)
- DetachPolicy
- RemoveAccountFromOrganization
- CreateGovCloudAccount
- EnableAWSServiceAccess
- DescribeOrganizationalUnit
- ListParents (Paginated)
- CreateAccount
- DeregisterDelegatedAdministrator
- TagResource
- ListCreateAccountStatus (Paginated)
- ListTargetsForPolicy (Paginated)
- DeclineHandshake
- UntagResource
- AttachPolicy
- ListPoliciesForTarget (Paginated)
- DescribeOrganization
- ListHandshakesForOrganization (Paginated)
- RegisterDelegatedAdministrator
- DeleteOrganizationalUnit
- UpdateOrganizationalUnit
- Types
- AccountJoinedMethod
- AccountStatus
- ActionType
- ChildType
- CreateAccountFailureReason
- CreateAccountState
- EffectivePolicyType
- HandshakePartyType
- HandshakeResourceType
- HandshakeState
- IAMUserAccessToBilling
- OrganizationFeatureSet
- ParentType
- PolicyType
- PolicyTypeStatus
- TargetType
- Account
- Child
- CreateAccountStatus
- DelegatedAdministrator
- DelegatedService
- EffectivePolicy
- EnabledServicePrincipal
- Handshake
- HandshakeFilter
- HandshakeParty
- HandshakeResource
- Organization
- OrganizationalUnit
- Parent
- Policy
- PolicySummary
- PolicyTargetSummary
- PolicyTypeSummary
- Root
- Tag
Derived from API version 2016-11-28
of the AWS service descriptions, licensed under Apache 2.0.
AWS Organizations is a web service that enables you to consolidate your multiple AWS accounts into an organization and centrally manage your accounts and their resources.
This guide provides descriptions of the Organizations operations. For more information about using this service, see the AWS Organizations User Guide.
Support and feedback for AWS Organizations
We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in the AWS Organizations support forum. For more information about the AWS support forums, see Forums Help.
Endpoint to call When using the AWS CLI or the AWS SDK
For the current release of Organizations, specify the us-east-1
region
for all AWS API and AWS CLI calls made from the commercial AWS Regions
outside of China. If calling from one of the AWS Regions in China, then
specify cn-northwest-1
. You can do this in the AWS CLI by using these
parameters and commands:
Use the following parameter with each command to specify both the endpoint and its region:
--endpoint-url https://organizations.us-east-1.amazonaws.com
(from commercial AWS Regions outside of China)or
--endpoint-url https://organizations.cn-northwest-1.amazonaws.com.cn
(from AWS Regions in China)Use the default endpoint, but configure your default region with this command:
aws configure set default.region us-east-1
/(from commercial AWS Regions outside of China)/or
aws configure set default.region cn-northwest-1
/(from AWS Regions in China)/Use the following parameter with each command to specify the endpoint:
--region us-east-1
/(from commercial AWS Regions outside of China)/or
--region cn-northwest-1
(from AWS Regions in China)
Recording API Requests
AWS Organizations supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by AWS CloudTrail, you can determine which requests the Organizations service received, who made the request and when, and so on. For more about AWS Organizations and its support for AWS CloudTrail, see Logging AWS Organizations Events with AWS CloudTrail in the AWS Organizations User Guide. To learn more about AWS CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Synopsis
- defaultService :: Service
- _PolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyTypeAlreadyEnabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _HandshakeConstraintViolationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError
- _RootNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _MasterCannotLeaveOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicatePolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConstraintViolationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountNotRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError
- _FinalizingOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError
- _HandshakeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyTypeNotAvailableForOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ChildNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedAPIEndpointException :: AsError a => Getting (First ServiceError) a ServiceError
- _EffectivePolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _OrganizationalUnitNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _DestinationParentNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _OrganizationNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountOwnerNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyTypeNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateHandshakeException :: AsError a => Getting (First ServiceError) a ServiceError
- _OrganizationalUnitNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _SourceParentNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TargetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _CreateAccountStatusNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _AlreadyInOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateOrganizationalUnitException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyChangesInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyNotAttachedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ParentNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedForDependencyException :: AsError a => Getting (First ServiceError) a ServiceError
- _AWSOrganizationsNotInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _PolicyInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidHandshakeTransitionException :: AsError a => Getting (First ServiceError) a ServiceError
- _HandshakeAlreadyInStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateAccountException :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicatePolicyAttachmentException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListHandshakesForAccount = ListHandshakesForAccount' (Maybe Text) (Maybe HandshakeFilter) (Maybe Natural)
- newListHandshakesForAccount :: ListHandshakesForAccount
- data ListHandshakesForAccountResponse = ListHandshakesForAccountResponse' (Maybe [Handshake]) (Maybe Text) Int
- newListHandshakesForAccountResponse :: Int -> ListHandshakesForAccountResponse
- data DescribeAccount = DescribeAccount' Text
- newDescribeAccount :: Text -> DescribeAccount
- data DescribeAccountResponse = DescribeAccountResponse' (Maybe Account) Int
- newDescribeAccountResponse :: Int -> DescribeAccountResponse
- data ListPolicies = ListPolicies' (Maybe Text) (Maybe Natural) PolicyType
- newListPolicies :: PolicyType -> ListPolicies
- data ListPoliciesResponse = ListPoliciesResponse' (Maybe Text) (Maybe [PolicySummary]) Int
- newListPoliciesResponse :: Int -> ListPoliciesResponse
- data CreatePolicy = CreatePolicy' (Maybe [Tag]) Text Text Text PolicyType
- newCreatePolicy :: Text -> Text -> Text -> PolicyType -> CreatePolicy
- data CreatePolicyResponse = CreatePolicyResponse' (Maybe Policy) Int
- newCreatePolicyResponse :: Int -> CreatePolicyResponse
- data ListRoots = ListRoots' (Maybe Text) (Maybe Natural)
- newListRoots :: ListRoots
- data ListRootsResponse = ListRootsResponse' (Maybe [Root]) (Maybe Text) Int
- newListRootsResponse :: Int -> ListRootsResponse
- data AcceptHandshake = AcceptHandshake' Text
- newAcceptHandshake :: Text -> AcceptHandshake
- data AcceptHandshakeResponse = AcceptHandshakeResponse' (Maybe Handshake) Int
- newAcceptHandshakeResponse :: Int -> AcceptHandshakeResponse
- data CreateOrganization = CreateOrganization' (Maybe OrganizationFeatureSet)
- newCreateOrganization :: CreateOrganization
- data CreateOrganizationResponse = CreateOrganizationResponse' (Maybe Organization) Int
- newCreateOrganizationResponse :: Int -> CreateOrganizationResponse
- data EnableAllFeatures = EnableAllFeatures' {
- newEnableAllFeatures :: EnableAllFeatures
- data EnableAllFeaturesResponse = EnableAllFeaturesResponse' (Maybe Handshake) Int
- newEnableAllFeaturesResponse :: Int -> EnableAllFeaturesResponse
- data DeleteOrganization = DeleteOrganization' {
- newDeleteOrganization :: DeleteOrganization
- data DeleteOrganizationResponse = DeleteOrganizationResponse' {
- newDeleteOrganizationResponse :: DeleteOrganizationResponse
- data DescribeHandshake = DescribeHandshake' Text
- newDescribeHandshake :: Text -> DescribeHandshake
- data DescribeHandshakeResponse = DescribeHandshakeResponse' (Maybe Handshake) Int
- newDescribeHandshakeResponse :: Int -> DescribeHandshakeResponse
- data ListTagsForResource = ListTagsForResource' (Maybe Text) Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DescribePolicy = DescribePolicy' Text
- newDescribePolicy :: Text -> DescribePolicy
- data DescribePolicyResponse = DescribePolicyResponse' (Maybe Policy) Int
- newDescribePolicyResponse :: Int -> DescribePolicyResponse
- data ListDelegatedServicesForAccount = ListDelegatedServicesForAccount' (Maybe Text) (Maybe Natural) Text
- newListDelegatedServicesForAccount :: Text -> ListDelegatedServicesForAccount
- data ListDelegatedServicesForAccountResponse = ListDelegatedServicesForAccountResponse' (Maybe [DelegatedService]) (Maybe Text) Int
- newListDelegatedServicesForAccountResponse :: Int -> ListDelegatedServicesForAccountResponse
- data DisableAWSServiceAccess = DisableAWSServiceAccess' Text
- newDisableAWSServiceAccess :: Text -> DisableAWSServiceAccess
- data DisableAWSServiceAccessResponse = DisableAWSServiceAccessResponse' {
- newDisableAWSServiceAccessResponse :: DisableAWSServiceAccessResponse
- data DescribeEffectivePolicy = DescribeEffectivePolicy' (Maybe Text) EffectivePolicyType
- newDescribeEffectivePolicy :: EffectivePolicyType -> DescribeEffectivePolicy
- data DescribeEffectivePolicyResponse = DescribeEffectivePolicyResponse' (Maybe EffectivePolicy) Int
- newDescribeEffectivePolicyResponse :: Int -> DescribeEffectivePolicyResponse
- data LeaveOrganization = LeaveOrganization' {
- newLeaveOrganization :: LeaveOrganization
- data LeaveOrganizationResponse = LeaveOrganizationResponse' {
- newLeaveOrganizationResponse :: LeaveOrganizationResponse
- data MoveAccount = MoveAccount' Text Text Text
- newMoveAccount :: Text -> Text -> Text -> MoveAccount
- data MoveAccountResponse = MoveAccountResponse' {
- newMoveAccountResponse :: MoveAccountResponse
- data ListAccounts = ListAccounts' (Maybe Text) (Maybe Natural)
- newListAccounts :: ListAccounts
- data ListAccountsResponse = ListAccountsResponse' (Maybe [Account]) (Maybe Text) Int
- newListAccountsResponse :: Int -> ListAccountsResponse
- data InviteAccountToOrganization = InviteAccountToOrganization' (Maybe (Sensitive Text)) (Maybe [Tag]) HandshakeParty
- newInviteAccountToOrganization :: HandshakeParty -> InviteAccountToOrganization
- data InviteAccountToOrganizationResponse = InviteAccountToOrganizationResponse' (Maybe Handshake) Int
- newInviteAccountToOrganizationResponse :: Int -> InviteAccountToOrganizationResponse
- data ListAWSServiceAccessForOrganization = ListAWSServiceAccessForOrganization' (Maybe Text) (Maybe Natural)
- newListAWSServiceAccessForOrganization :: ListAWSServiceAccessForOrganization
- data ListAWSServiceAccessForOrganizationResponse = ListAWSServiceAccessForOrganizationResponse' (Maybe Text) (Maybe [EnabledServicePrincipal]) Int
- newListAWSServiceAccessForOrganizationResponse :: Int -> ListAWSServiceAccessForOrganizationResponse
- data ListOrganizationalUnitsForParent = ListOrganizationalUnitsForParent' (Maybe Text) (Maybe Natural) Text
- newListOrganizationalUnitsForParent :: Text -> ListOrganizationalUnitsForParent
- data ListOrganizationalUnitsForParentResponse = ListOrganizationalUnitsForParentResponse' (Maybe Text) (Maybe [OrganizationalUnit]) Int
- newListOrganizationalUnitsForParentResponse :: Int -> ListOrganizationalUnitsForParentResponse
- data CancelHandshake = CancelHandshake' Text
- newCancelHandshake :: Text -> CancelHandshake
- data CancelHandshakeResponse = CancelHandshakeResponse' (Maybe Handshake) Int
- newCancelHandshakeResponse :: Int -> CancelHandshakeResponse
- data ListChildren = ListChildren' (Maybe Text) (Maybe Natural) Text ChildType
- newListChildren :: Text -> ChildType -> ListChildren
- data ListChildrenResponse = ListChildrenResponse' (Maybe [Child]) (Maybe Text) Int
- newListChildrenResponse :: Int -> ListChildrenResponse
- data ListDelegatedAdministrators = ListDelegatedAdministrators' (Maybe Text) (Maybe Text) (Maybe Natural)
- newListDelegatedAdministrators :: ListDelegatedAdministrators
- data ListDelegatedAdministratorsResponse = ListDelegatedAdministratorsResponse' (Maybe [DelegatedAdministrator]) (Maybe Text) Int
- newListDelegatedAdministratorsResponse :: Int -> ListDelegatedAdministratorsResponse
- data DeletePolicy = DeletePolicy' Text
- newDeletePolicy :: Text -> DeletePolicy
- data DeletePolicyResponse = DeletePolicyResponse' {
- newDeletePolicyResponse :: DeletePolicyResponse
- data UpdatePolicy = UpdatePolicy' (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdatePolicy :: Text -> UpdatePolicy
- data UpdatePolicyResponse = UpdatePolicyResponse' (Maybe Policy) Int
- newUpdatePolicyResponse :: Int -> UpdatePolicyResponse
- data EnablePolicyType = EnablePolicyType' Text PolicyType
- newEnablePolicyType :: Text -> PolicyType -> EnablePolicyType
- data EnablePolicyTypeResponse = EnablePolicyTypeResponse' (Maybe Root) Int
- newEnablePolicyTypeResponse :: Int -> EnablePolicyTypeResponse
- data DisablePolicyType = DisablePolicyType' Text PolicyType
- newDisablePolicyType :: Text -> PolicyType -> DisablePolicyType
- data DisablePolicyTypeResponse = DisablePolicyTypeResponse' (Maybe Root) Int
- newDisablePolicyTypeResponse :: Int -> DisablePolicyTypeResponse
- data DescribeCreateAccountStatus = DescribeCreateAccountStatus' Text
- newDescribeCreateAccountStatus :: Text -> DescribeCreateAccountStatus
- data DescribeCreateAccountStatusResponse = DescribeCreateAccountStatusResponse' (Maybe CreateAccountStatus) Int
- newDescribeCreateAccountStatusResponse :: Int -> DescribeCreateAccountStatusResponse
- data CreateOrganizationalUnit = CreateOrganizationalUnit' (Maybe [Tag]) Text Text
- newCreateOrganizationalUnit :: Text -> Text -> CreateOrganizationalUnit
- data CreateOrganizationalUnitResponse = CreateOrganizationalUnitResponse' (Maybe OrganizationalUnit) Int
- newCreateOrganizationalUnitResponse :: Int -> CreateOrganizationalUnitResponse
- data ListAccountsForParent = ListAccountsForParent' (Maybe Text) (Maybe Natural) Text
- newListAccountsForParent :: Text -> ListAccountsForParent
- data ListAccountsForParentResponse = ListAccountsForParentResponse' (Maybe [Account]) (Maybe Text) Int
- newListAccountsForParentResponse :: Int -> ListAccountsForParentResponse
- data DetachPolicy = DetachPolicy' Text Text
- newDetachPolicy :: Text -> Text -> DetachPolicy
- data DetachPolicyResponse = DetachPolicyResponse' {
- newDetachPolicyResponse :: DetachPolicyResponse
- data RemoveAccountFromOrganization = RemoveAccountFromOrganization' Text
- newRemoveAccountFromOrganization :: Text -> RemoveAccountFromOrganization
- data RemoveAccountFromOrganizationResponse = RemoveAccountFromOrganizationResponse' {
- newRemoveAccountFromOrganizationResponse :: RemoveAccountFromOrganizationResponse
- data CreateGovCloudAccount = CreateGovCloudAccount' (Maybe IAMUserAccessToBilling) (Maybe Text) (Maybe [Tag]) (Sensitive Text) (Sensitive Text)
- newCreateGovCloudAccount :: Text -> Text -> CreateGovCloudAccount
- data CreateGovCloudAccountResponse = CreateGovCloudAccountResponse' (Maybe CreateAccountStatus) Int
- newCreateGovCloudAccountResponse :: Int -> CreateGovCloudAccountResponse
- data EnableAWSServiceAccess = EnableAWSServiceAccess' Text
- newEnableAWSServiceAccess :: Text -> EnableAWSServiceAccess
- data EnableAWSServiceAccessResponse = EnableAWSServiceAccessResponse' {
- newEnableAWSServiceAccessResponse :: EnableAWSServiceAccessResponse
- data DescribeOrganizationalUnit = DescribeOrganizationalUnit' Text
- newDescribeOrganizationalUnit :: Text -> DescribeOrganizationalUnit
- data DescribeOrganizationalUnitResponse = DescribeOrganizationalUnitResponse' (Maybe OrganizationalUnit) Int
- newDescribeOrganizationalUnitResponse :: Int -> DescribeOrganizationalUnitResponse
- data ListParents = ListParents' (Maybe Text) (Maybe Natural) Text
- newListParents :: Text -> ListParents
- data ListParentsResponse = ListParentsResponse' (Maybe Text) (Maybe [Parent]) Int
- newListParentsResponse :: Int -> ListParentsResponse
- data CreateAccount = CreateAccount' (Maybe IAMUserAccessToBilling) (Maybe Text) (Maybe [Tag]) (Sensitive Text) (Sensitive Text)
- newCreateAccount :: Text -> Text -> CreateAccount
- data CreateAccountResponse = CreateAccountResponse' (Maybe CreateAccountStatus) Int
- newCreateAccountResponse :: Int -> CreateAccountResponse
- data DeregisterDelegatedAdministrator = DeregisterDelegatedAdministrator' Text Text
- newDeregisterDelegatedAdministrator :: Text -> Text -> DeregisterDelegatedAdministrator
- data DeregisterDelegatedAdministratorResponse = DeregisterDelegatedAdministratorResponse' {
- newDeregisterDelegatedAdministratorResponse :: DeregisterDelegatedAdministratorResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data ListCreateAccountStatus = ListCreateAccountStatus' (Maybe [CreateAccountState]) (Maybe Text) (Maybe Natural)
- newListCreateAccountStatus :: ListCreateAccountStatus
- data ListCreateAccountStatusResponse = ListCreateAccountStatusResponse' (Maybe [CreateAccountStatus]) (Maybe Text) Int
- newListCreateAccountStatusResponse :: Int -> ListCreateAccountStatusResponse
- data ListTargetsForPolicy = ListTargetsForPolicy' (Maybe Text) (Maybe Natural) Text
- newListTargetsForPolicy :: Text -> ListTargetsForPolicy
- data ListTargetsForPolicyResponse = ListTargetsForPolicyResponse' (Maybe Text) (Maybe [PolicyTargetSummary]) Int
- newListTargetsForPolicyResponse :: Int -> ListTargetsForPolicyResponse
- data DeclineHandshake = DeclineHandshake' Text
- newDeclineHandshake :: Text -> DeclineHandshake
- data DeclineHandshakeResponse = DeclineHandshakeResponse' (Maybe Handshake) Int
- newDeclineHandshakeResponse :: Int -> DeclineHandshakeResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data AttachPolicy = AttachPolicy' Text Text
- newAttachPolicy :: Text -> Text -> AttachPolicy
- data AttachPolicyResponse = AttachPolicyResponse' {
- newAttachPolicyResponse :: AttachPolicyResponse
- data ListPoliciesForTarget = ListPoliciesForTarget' (Maybe Text) (Maybe Natural) Text PolicyType
- newListPoliciesForTarget :: Text -> PolicyType -> ListPoliciesForTarget
- data ListPoliciesForTargetResponse = ListPoliciesForTargetResponse' (Maybe Text) (Maybe [PolicySummary]) Int
- newListPoliciesForTargetResponse :: Int -> ListPoliciesForTargetResponse
- data DescribeOrganization = DescribeOrganization' {
- newDescribeOrganization :: DescribeOrganization
- data DescribeOrganizationResponse = DescribeOrganizationResponse' (Maybe Organization) Int
- newDescribeOrganizationResponse :: Int -> DescribeOrganizationResponse
- data ListHandshakesForOrganization = ListHandshakesForOrganization' (Maybe Text) (Maybe HandshakeFilter) (Maybe Natural)
- newListHandshakesForOrganization :: ListHandshakesForOrganization
- data ListHandshakesForOrganizationResponse = ListHandshakesForOrganizationResponse' (Maybe [Handshake]) (Maybe Text) Int
- newListHandshakesForOrganizationResponse :: Int -> ListHandshakesForOrganizationResponse
- data RegisterDelegatedAdministrator = RegisterDelegatedAdministrator' Text Text
- newRegisterDelegatedAdministrator :: Text -> Text -> RegisterDelegatedAdministrator
- data RegisterDelegatedAdministratorResponse = RegisterDelegatedAdministratorResponse' {
- newRegisterDelegatedAdministratorResponse :: RegisterDelegatedAdministratorResponse
- data DeleteOrganizationalUnit = DeleteOrganizationalUnit' Text
- newDeleteOrganizationalUnit :: Text -> DeleteOrganizationalUnit
- data DeleteOrganizationalUnitResponse = DeleteOrganizationalUnitResponse' {
- newDeleteOrganizationalUnitResponse :: DeleteOrganizationalUnitResponse
- data UpdateOrganizationalUnit = UpdateOrganizationalUnit' (Maybe Text) Text
- newUpdateOrganizationalUnit :: Text -> UpdateOrganizationalUnit
- data UpdateOrganizationalUnitResponse = UpdateOrganizationalUnitResponse' (Maybe OrganizationalUnit) Int
- newUpdateOrganizationalUnitResponse :: Int -> UpdateOrganizationalUnitResponse
- newtype AccountJoinedMethod where
- newtype AccountStatus where
- AccountStatus' { }
- pattern AccountStatus_ACTIVE :: AccountStatus
- pattern AccountStatus_SUSPENDED :: AccountStatus
- newtype ActionType where
- ActionType' { }
- pattern ActionType_ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE :: ActionType
- pattern ActionType_APPROVE_ALL_FEATURES :: ActionType
- pattern ActionType_ENABLE_ALL_FEATURES :: ActionType
- pattern ActionType_INVITE :: ActionType
- newtype ChildType where
- ChildType' { }
- pattern ChildType_ACCOUNT :: ChildType
- pattern ChildType_ORGANIZATIONAL_UNIT :: ChildType
- newtype CreateAccountFailureReason where
- CreateAccountFailureReason' { }
- pattern CreateAccountFailureReason_ACCOUNT_LIMIT_EXCEEDED :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_CONCURRENT_ACCOUNT_MODIFICATION :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_EMAIL_ALREADY_EXISTS :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_FAILED_BUSINESS_VALIDATION :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_GOVCLOUD_ACCOUNT_ALREADY_EXISTS :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_INTERNAL_FAILURE :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_INVALID_ADDRESS :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_INVALID_EMAIL :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_INVALID_IDENTITY_FOR_BUSINESS_VALIDATION :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_MISSING_BUSINESS_VALIDATION :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_MISSING_PAYMENT_INSTRUMENT :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_PENDING_BUSINESS_VALIDATION :: CreateAccountFailureReason
- pattern CreateAccountFailureReason_UNKNOWN_BUSINESS_VALIDATION :: CreateAccountFailureReason
- newtype CreateAccountState where
- newtype EffectivePolicyType where
- newtype HandshakePartyType where
- HandshakePartyType' { }
- pattern HandshakePartyType_ACCOUNT :: HandshakePartyType
- pattern HandshakePartyType_EMAIL :: HandshakePartyType
- pattern HandshakePartyType_ORGANIZATION :: HandshakePartyType
- newtype HandshakeResourceType where
- HandshakeResourceType' { }
- pattern HandshakeResourceType_ACCOUNT :: HandshakeResourceType
- pattern HandshakeResourceType_EMAIL :: HandshakeResourceType
- pattern HandshakeResourceType_MASTER_EMAIL :: HandshakeResourceType
- pattern HandshakeResourceType_MASTER_NAME :: HandshakeResourceType
- pattern HandshakeResourceType_NOTES :: HandshakeResourceType
- pattern HandshakeResourceType_ORGANIZATION :: HandshakeResourceType
- pattern HandshakeResourceType_ORGANIZATION_FEATURE_SET :: HandshakeResourceType
- pattern HandshakeResourceType_PARENT_HANDSHAKE :: HandshakeResourceType
- newtype HandshakeState where
- HandshakeState' { }
- pattern HandshakeState_ACCEPTED :: HandshakeState
- pattern HandshakeState_CANCELED :: HandshakeState
- pattern HandshakeState_DECLINED :: HandshakeState
- pattern HandshakeState_EXPIRED :: HandshakeState
- pattern HandshakeState_OPEN :: HandshakeState
- pattern HandshakeState_REQUESTED :: HandshakeState
- newtype IAMUserAccessToBilling where
- newtype OrganizationFeatureSet where
- newtype ParentType where
- ParentType' { }
- pattern ParentType_ORGANIZATIONAL_UNIT :: ParentType
- pattern ParentType_ROOT :: ParentType
- newtype PolicyType where
- PolicyType' { }
- pattern PolicyType_AISERVICES_OPT_OUT_POLICY :: PolicyType
- pattern PolicyType_BACKUP_POLICY :: PolicyType
- pattern PolicyType_SERVICE_CONTROL_POLICY :: PolicyType
- pattern PolicyType_TAG_POLICY :: PolicyType
- newtype PolicyTypeStatus where
- PolicyTypeStatus' { }
- pattern PolicyTypeStatus_ENABLED :: PolicyTypeStatus
- pattern PolicyTypeStatus_PENDING_DISABLE :: PolicyTypeStatus
- pattern PolicyTypeStatus_PENDING_ENABLE :: PolicyTypeStatus
- newtype TargetType where
- TargetType' { }
- pattern TargetType_ACCOUNT :: TargetType
- pattern TargetType_ORGANIZATIONAL_UNIT :: TargetType
- pattern TargetType_ROOT :: TargetType
- data Account = Account' (Maybe AccountStatus) (Maybe AccountJoinedMethod) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text)
- newAccount :: Account
- data Child = Child' (Maybe Text) (Maybe ChildType)
- newChild :: Child
- data CreateAccountStatus = CreateAccountStatus' (Maybe CreateAccountFailureReason) (Maybe CreateAccountState) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newCreateAccountStatus :: CreateAccountStatus
- data DelegatedAdministrator = DelegatedAdministrator' (Maybe AccountStatus) (Maybe AccountJoinedMethod) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text)
- newDelegatedAdministrator :: DelegatedAdministrator
- data DelegatedService = DelegatedService' (Maybe Text) (Maybe POSIX)
- newDelegatedService :: DelegatedService
- data EffectivePolicy = EffectivePolicy' (Maybe Text) (Maybe EffectivePolicyType) (Maybe POSIX) (Maybe Text)
- newEffectivePolicy :: EffectivePolicy
- data EnabledServicePrincipal = EnabledServicePrincipal' (Maybe Text) (Maybe POSIX)
- newEnabledServicePrincipal :: EnabledServicePrincipal
- data Handshake = Handshake' (Maybe HandshakeState) (Maybe Text) (Maybe ActionType) (Maybe [HandshakeResource]) (Maybe Text) (Maybe POSIX) (Maybe [HandshakeParty]) (Maybe POSIX)
- newHandshake :: Handshake
- data HandshakeFilter = HandshakeFilter' (Maybe Text) (Maybe ActionType)
- newHandshakeFilter :: HandshakeFilter
- data HandshakeParty = HandshakeParty' (Sensitive Text) HandshakePartyType
- newHandshakeParty :: Text -> HandshakePartyType -> HandshakeParty
- data HandshakeResource = HandshakeResource' (Maybe (Sensitive Text)) (Maybe [HandshakeResource]) (Maybe HandshakeResourceType)
- newHandshakeResource :: HandshakeResource
- data Organization = Organization' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe [PolicyTypeSummary]) (Maybe Text) (Maybe OrganizationFeatureSet)
- newOrganization :: Organization
- data OrganizationalUnit = OrganizationalUnit' (Maybe Text) (Maybe Text) (Maybe Text)
- newOrganizationalUnit :: OrganizationalUnit
- data Parent = Parent' (Maybe Text) (Maybe ParentType)
- newParent :: Parent
- data Policy = Policy' (Maybe Text) (Maybe PolicySummary)
- newPolicy :: Policy
- data PolicySummary = PolicySummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe PolicyType) (Maybe Text)
- newPolicySummary :: PolicySummary
- data PolicyTargetSummary = PolicyTargetSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TargetType)
- newPolicyTargetSummary :: PolicyTargetSummary
- data PolicyTypeSummary = PolicyTypeSummary' (Maybe PolicyTypeStatus) (Maybe PolicyType)
- newPolicyTypeSummary :: PolicyTypeSummary
- data Root = Root' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [PolicyTypeSummary])
- newRoot :: Root
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2016-11-28
of the Amazon Organizations SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Organizations
.
PolicyNotFoundException
_PolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find a policy with the PolicyId
that you specified.
PolicyTypeAlreadyEnabledException
_PolicyTypeAlreadyEnabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified policy type is already enabled in the specified root.
HandshakeConstraintViolationException
_HandshakeConstraintViolationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation would violate the constraint identified in the reason code.
Some of the reasons in the following list might not be applicable to this specific API or operation:
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note that deleted and closed accounts still count toward your limit.
If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.
- ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.
- HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.
- INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.
- ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.
- ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is invalid because the organization has already started the process to enable all features.
- ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.
- ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.
- PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
MalformedPolicyDocumentException
_MalformedPolicyDocumentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The provided policy document doesn't meet the requirements of the specified policy type. For example, the syntax might be incorrect. For details about service control policy syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.
RootNotFoundException
_RootNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find a root with the RootId
that you specified.
MasterCannotLeaveOrganizationException
_MasterCannotLeaveOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't remove a management account from an organization. If you want the management account to become a member account in another organization, you must first delete the current organization of the management account.
AccountNotFoundException
_AccountNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find an AWS account with the AccountId
that you specified,
or the account whose credentials you used to make this request isn't a
member of an organization.
AccountAlreadyRegisteredException
_AccountAlreadyRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified account is already a delegated administrator for this AWS service.
DuplicatePolicyException
_DuplicatePolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A policy with the same name already exists.
ConstraintViolationException
_ConstraintViolationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:
Some of the reasons in the following list might not be applicable to this specific API or operation.
- ACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management account from the organization. You can't remove the management account. Instead, after you remove all member accounts, delete the organization itself.
- ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at Removing a member account from your organizationin the AWS Organizations User Guide.
- ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at Removing a member account from your organization in the AWS Organizations User Guide.
- ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.
ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.
Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.
Deleted and closed accounts still count toward your limit.
If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact AWS Support.
- CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the management account of the organization as a delegated administrator for an AWS service integrated with Organizations. You can designate only a member account as a delegated administrator.
- CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.
- CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.
- DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an AWS account as a delegated administrator for an AWS service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.
- EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.
- HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.
- MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's management account to the marketplace that corresponds to the management account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.
- MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the AWS Regions in China. To create an organization, the master must have a valid business license. For more information, contact customer support.
- MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the management account. Then try the operation again.
- MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the management account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.
- MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this management account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
- MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.
- MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.
- MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.
- MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.
- MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.
- ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.
- OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.
- OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.
- POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.
- POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies that you can have in an organization.
- TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.
AccountNotRegisteredException
_AccountNotRegisteredException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified account is not a delegated administrator for this AWS service.
FinalizingOrganizationException
_FinalizingOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
AWS Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact AWS Support.
HandshakeNotFoundException
_HandshakeNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find a handshake with the HandshakeId
that you specified.
PolicyTypeNotAvailableForOrganizationException
_PolicyTypeNotAvailableForOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't use the specified policy type with the feature set currently enabled for this organization. For example, you can enable SCPs only after you enable all features in the organization. For more information, see Managing AWS Organizations Policiesin the AWS Organizations User Guide.
ChildNotFoundException
_ChildNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find an organizational unit (OU) or AWS account with the
ChildId
that you specified.
UnsupportedAPIEndpointException
_UnsupportedAPIEndpointException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This action isn't available in the current AWS Region.
EffectivePolicyNotFoundException
_EffectivePolicyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
If you ran this action on the management account, this policy type is not enabled. If you ran the action on a member account, the account doesn't have an effective policy of this type. Contact the administrator of your organization about attaching a policy of this type to the account.
OrganizationalUnitNotFoundException
_OrganizationalUnitNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find an OU with the OrganizationalUnitId
that you specified.
DestinationParentNotFoundException
_DestinationParentNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find the destination container (a root or OU) with the
ParentId
that you specified.
OrganizationNotEmptyException
_OrganizationNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The organization isn't empty. To delete an organization, you must first remove all accounts except the management account, delete all OUs, and delete all policies.
AccountOwnerNotVerifiedException
_AccountOwnerNotVerifiedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't invite an existing account to your organization until you verify that you own the email address associated with the management account. For more information, see Email Address Verification in the AWS Organizations User Guide.
PolicyTypeNotEnabledException
_PolicyTypeNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified policy type isn't currently enabled in this root. You can't attach policies of the specified type to entities in a root until you enable that type in the root. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
DuplicateHandshakeException
_DuplicateHandshakeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A handshake with the same action and target already exists. For example, if you invited an account to join your organization, the invited account might already have a pending invitation from this organization. If you intend to resend an invitation to an account, ensure that existing handshakes that might be considered duplicates are canceled or declined.
OrganizationalUnitNotEmptyException
_OrganizationalUnitNotEmptyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified OU is not empty. Move all accounts to another root or to other OUs, remove all child OUs, and try the operation again.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later.
For information about quotas that affect AWS Organizations, see Quotas for AWS Organizationsin the AWS Organizations User Guide.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The target of the operation is currently being modified by a different request. Try again later.
ServiceException
_ServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
AWS Organizations can't complete your request because of an internal service error. Try again later.
SourceParentNotFoundException
_SourceParentNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find a source root or OU with the ParentId
that you
specified.
TargetNotFoundException
_TargetNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find a root, OU, account, or policy with the TargetId
that
you specified.
CreateAccountStatusNotFoundException
_CreateAccountStatusNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find an create account request with the
CreateAccountRequestId
that you specified.
AlreadyInOrganizationException
_AlreadyInOrganizationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This account is already a member of an organization. An account can belong to only one organization at a time.
DuplicateOrganizationalUnitException
_DuplicateOrganizationalUnitException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An OU with the same name already exists.
InvalidInputException
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:
Some of the reasons in the following list might not be applicable to this specific API or operation.
- DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.
- IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.
- INPUT_REQUIRED: You must include a value for all required parameters.
- INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.
- INVALID_ENUM: You specified an invalid value.
- INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.
- INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.
- INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.
- INVALID_PAGINATION_TOKEN: Get the value for the
NextToken
parameter from the response to a previous call of the operation. - INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.
- INVALID_PATTERN: You provided a value that doesn't match the required pattern.
- INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.
- INVALID_ROLE_NAME: You provided a role name that isn't valid. A
role name can't begin with the reserved prefix
AWSServiceRoleFor
. - INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.
- INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.
- INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.
- MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.
- MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.
- MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.
- MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.
- MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.
- MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
- TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.
- UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.
PolicyChangesInProgressException
_PolicyChangesInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Changes to the effective policy are in progress, and its contents can't be returned. Try the operation again later.
PolicyNotAttachedException
_PolicyNotAttachedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The policy isn't attached to the specified target in the specified root.
ParentNotFoundException
_ParentNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find a root or OU with the ParentId
that you specified.
AccessDeniedForDependencyException
_AccessDeniedForDependencyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation that you attempted requires you to have the
iam:CreateServiceLinkedRole
for organizations.amazonaws.com
permission so that AWS Organizations can create the required
service-linked role. You don't have that permission.
AWSOrganizationsNotInUseException
_AWSOrganizationsNotInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.
PolicyInUseException
_PolicyInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The policy is attached to one or more entities. You must detach it from all roots, OUs, and accounts before performing this operation.
InvalidHandshakeTransitionException
_InvalidHandshakeTransitionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can't perform the operation on the handshake in its current state. For example, you can't cancel a handshake that was already accepted or accept a handshake that was already declined.
HandshakeAlreadyInStateException
_HandshakeAlreadyInStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified handshake is already in the requested state. For example, you can't accept a handshake that was already accepted.
DuplicateAccountException
_DuplicateAccountException :: AsError a => Getting (First ServiceError) a ServiceError Source #
That account is already present in the specified destination.
DuplicatePolicyAttachmentException
_DuplicatePolicyAttachmentException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The selected policy is already attached to the specified target.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListHandshakesForAccount (Paginated)
data ListHandshakesForAccount Source #
See: newListHandshakesForAccount
smart constructor.
Instances
newListHandshakesForAccount :: ListHandshakesForAccount Source #
Create a value of ListHandshakesForAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListHandshakesForAccount'
, listHandshakesForAccount_nextToken
- 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.
$sel:filter':ListHandshakesForAccount'
, listHandshakesForAccount_filter
- 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.
$sel:maxResults:ListHandshakesForAccount'
, listHandshakesForAccount_maxResults
- 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.
data ListHandshakesForAccountResponse Source #
See: newListHandshakesForAccountResponse
smart constructor.
Instances
newListHandshakesForAccountResponse Source #
Create a value of ListHandshakesForAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshakes:ListHandshakesForAccountResponse'
, listHandshakesForAccountResponse_handshakes
- A list of Handshake objects with details about each of the handshakes
that is associated with the specified account.
$sel:nextToken:ListHandshakesForAccount'
, listHandshakesForAccountResponse_nextToken
- 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
.
$sel:httpStatus:ListHandshakesForAccountResponse'
, listHandshakesForAccountResponse_httpStatus
- The response's http status code.
DescribeAccount
data DescribeAccount Source #
See: newDescribeAccount
smart constructor.
Instances
Create a value of DescribeAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:DescribeAccount'
, describeAccount_accountId
- 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.
data DescribeAccountResponse Source #
See: newDescribeAccountResponse
smart constructor.
Instances
newDescribeAccountResponse Source #
Create a value of DescribeAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:account:DescribeAccountResponse'
, describeAccountResponse_account
- A structure that contains information about the requested account.
$sel:httpStatus:DescribeAccountResponse'
, describeAccountResponse_httpStatus
- The response's http status code.
ListPolicies (Paginated)
data ListPolicies Source #
See: newListPolicies
smart constructor.
Instances
Create a value of ListPolicies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPolicies'
, listPolicies_nextToken
- 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.
$sel:maxResults:ListPolicies'
, listPolicies_maxResults
- 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.
$sel:filter':ListPolicies'
, listPolicies_filter
- Specifies the type of policy that you want to include in the response.
You must specify one of the following values:
data ListPoliciesResponse Source #
See: newListPoliciesResponse
smart constructor.
Instances
newListPoliciesResponse Source #
Create a value of ListPoliciesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPolicies'
, listPoliciesResponse_nextToken
- 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
.
$sel:policies:ListPoliciesResponse'
, listPoliciesResponse_policies
- 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.
$sel:httpStatus:ListPoliciesResponse'
, listPoliciesResponse_httpStatus
- The response's http status code.
CreatePolicy
data CreatePolicy Source #
See: newCreatePolicy
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> PolicyType | |
-> CreatePolicy |
Create a value of CreatePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreatePolicy'
, createPolicy_tags
- 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.
$sel:content:CreatePolicy'
, createPolicy_content
- 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.
$sel:description:CreatePolicy'
, createPolicy_description
- An optional description to assign to the policy.
$sel:name:CreatePolicy'
, createPolicy_name
- 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.
$sel:type':CreatePolicy'
, createPolicy_type
- The type of policy to create. You can specify one of the following
values:
data CreatePolicyResponse Source #
See: newCreatePolicyResponse
smart constructor.
Instances
newCreatePolicyResponse Source #
Create a value of CreatePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:CreatePolicyResponse'
, createPolicyResponse_policy
- A structure that contains details about the newly created policy.
$sel:httpStatus:CreatePolicyResponse'
, createPolicyResponse_httpStatus
- The response's http status code.
ListRoots (Paginated)
See: newListRoots
smart constructor.
ListRoots' (Maybe Text) (Maybe Natural) |
Instances
newListRoots :: ListRoots Source #
Create a value of ListRoots
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListRoots'
, listRoots_nextToken
- 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.
$sel:maxResults:ListRoots'
, listRoots_maxResults
- 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.
data ListRootsResponse Source #
See: newListRootsResponse
smart constructor.
Instances
Create a value of ListRootsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roots:ListRootsResponse'
, listRootsResponse_roots
- A list of roots that are defined in an organization.
$sel:nextToken:ListRoots'
, listRootsResponse_nextToken
- 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
.
$sel:httpStatus:ListRootsResponse'
, listRootsResponse_httpStatus
- The response's http status code.
AcceptHandshake
data AcceptHandshake Source #
See: newAcceptHandshake
smart constructor.
Instances
Create a value of AcceptHandshake
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshakeId:AcceptHandshake'
, acceptHandshake_handshakeId
- 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.
data AcceptHandshakeResponse Source #
See: newAcceptHandshakeResponse
smart constructor.
Instances
newAcceptHandshakeResponse Source #
Create a value of AcceptHandshakeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshake:AcceptHandshakeResponse'
, acceptHandshakeResponse_handshake
- A structure that contains details about the accepted handshake.
$sel:httpStatus:AcceptHandshakeResponse'
, acceptHandshakeResponse_httpStatus
- The response's http status code.
CreateOrganization
data CreateOrganization Source #
See: newCreateOrganization
smart constructor.
Instances
newCreateOrganization :: CreateOrganization Source #
Create a value of CreateOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featureSet:CreateOrganization'
, createOrganization_featureSet
- 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.
data CreateOrganizationResponse Source #
See: newCreateOrganizationResponse
smart constructor.
Instances
newCreateOrganizationResponse Source #
Create a value of CreateOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organization:CreateOrganizationResponse'
, createOrganizationResponse_organization
- A structure that contains details about the newly created organization.
$sel:httpStatus:CreateOrganizationResponse'
, createOrganizationResponse_httpStatus
- The response's http status code.
EnableAllFeatures
data EnableAllFeatures Source #
See: newEnableAllFeatures
smart constructor.
Instances
newEnableAllFeatures :: EnableAllFeatures Source #
Create a value of EnableAllFeatures
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data EnableAllFeaturesResponse Source #
See: newEnableAllFeaturesResponse
smart constructor.
Instances
newEnableAllFeaturesResponse Source #
Create a value of EnableAllFeaturesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshake:EnableAllFeaturesResponse'
, enableAllFeaturesResponse_handshake
- A structure that contains details about the handshake created to support
this request to enable all features in the organization.
$sel:httpStatus:EnableAllFeaturesResponse'
, enableAllFeaturesResponse_httpStatus
- The response's http status code.
DeleteOrganization
data DeleteOrganization Source #
See: newDeleteOrganization
smart constructor.
Instances
newDeleteOrganization :: DeleteOrganization Source #
Create a value of DeleteOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DeleteOrganizationResponse Source #
See: newDeleteOrganizationResponse
smart constructor.
Instances
newDeleteOrganizationResponse :: DeleteOrganizationResponse Source #
Create a value of DeleteOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeHandshake
data DescribeHandshake Source #
See: newDescribeHandshake
smart constructor.
Instances
Create a value of DescribeHandshake
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshakeId:DescribeHandshake'
, describeHandshake_handshakeId
- 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.
data DescribeHandshakeResponse Source #
See: newDescribeHandshakeResponse
smart constructor.
Instances
newDescribeHandshakeResponse Source #
Create a value of DescribeHandshakeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshake:DescribeHandshakeResponse'
, describeHandshakeResponse_handshake
- A structure that contains information about the specified handshake.
$sel:httpStatus:DescribeHandshakeResponse'
, describeHandshakeResponse_httpStatus
- The response's http status code.
ListTagsForResource (Paginated)
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListTagsForResource'
, listTagsForResource_nextToken
- 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.
$sel:resourceId:ListTagsForResource'
, listTagsForResource_resourceId
- 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
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListTagsForResource'
, listTagsForResourceResponse_nextToken
- 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
.
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags that are assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
DescribePolicy
data DescribePolicy Source #
See: newDescribePolicy
smart constructor.
Instances
Create a value of DescribePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyId:DescribePolicy'
, describePolicy_policyId
- 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 (_).
data DescribePolicyResponse Source #
See: newDescribePolicyResponse
smart constructor.
Instances
newDescribePolicyResponse Source #
Create a value of DescribePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:DescribePolicyResponse'
, describePolicyResponse_policy
- A structure that contains details about the specified policy.
$sel:httpStatus:DescribePolicyResponse'
, describePolicyResponse_httpStatus
- The response's http status code.
ListDelegatedServicesForAccount (Paginated)
data ListDelegatedServicesForAccount Source #
See: newListDelegatedServicesForAccount
smart constructor.
Instances
newListDelegatedServicesForAccount Source #
Create a value of ListDelegatedServicesForAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListDelegatedServicesForAccount'
, listDelegatedServicesForAccount_nextToken
- 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.
$sel:maxResults:ListDelegatedServicesForAccount'
, listDelegatedServicesForAccount_maxResults
- 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.
$sel:accountId:ListDelegatedServicesForAccount'
, listDelegatedServicesForAccount_accountId
- The account ID number of a delegated administrator account in the
organization.
data ListDelegatedServicesForAccountResponse Source #
See: newListDelegatedServicesForAccountResponse
smart constructor.
Instances
newListDelegatedServicesForAccountResponse Source #
Create a value of ListDelegatedServicesForAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:delegatedServices:ListDelegatedServicesForAccountResponse'
, listDelegatedServicesForAccountResponse_delegatedServices
- The services for which the account is a delegated administrator.
$sel:nextToken:ListDelegatedServicesForAccount'
, listDelegatedServicesForAccountResponse_nextToken
- 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
.
$sel:httpStatus:ListDelegatedServicesForAccountResponse'
, listDelegatedServicesForAccountResponse_httpStatus
- The response's http status code.
DisableAWSServiceAccess
data DisableAWSServiceAccess Source #
See: newDisableAWSServiceAccess
smart constructor.
Instances
newDisableAWSServiceAccess Source #
Create a value of DisableAWSServiceAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:servicePrincipal:DisableAWSServiceAccess'
, disableAWSServiceAccess_servicePrincipal
- 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
.
data DisableAWSServiceAccessResponse Source #
See: newDisableAWSServiceAccessResponse
smart constructor.
Instances
Eq DisableAWSServiceAccessResponse Source # | |
Read DisableAWSServiceAccessResponse Source # | |
Show DisableAWSServiceAccessResponse Source # | |
Generic DisableAWSServiceAccessResponse Source # | |
NFData DisableAWSServiceAccessResponse Source # | |
Defined in Amazonka.Organizations.DisableAWSServiceAccess rnf :: DisableAWSServiceAccessResponse -> () # | |
type Rep DisableAWSServiceAccessResponse Source # | |
Defined in Amazonka.Organizations.DisableAWSServiceAccess type Rep DisableAWSServiceAccessResponse = D1 ('MetaData "DisableAWSServiceAccessResponse" "Amazonka.Organizations.DisableAWSServiceAccess" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DisableAWSServiceAccessResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDisableAWSServiceAccessResponse :: DisableAWSServiceAccessResponse Source #
Create a value of DisableAWSServiceAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeEffectivePolicy
data DescribeEffectivePolicy Source #
See: newDescribeEffectivePolicy
smart constructor.
Instances
newDescribeEffectivePolicy Source #
Create a value of DescribeEffectivePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetId:DescribeEffectivePolicy'
, describeEffectivePolicy_targetId
- 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.
$sel:policyType:DescribeEffectivePolicy'
, describeEffectivePolicy_policyType
- The type of policy that you want information about. You can specify one
of the following values:
data DescribeEffectivePolicyResponse Source #
See: newDescribeEffectivePolicyResponse
smart constructor.
Instances
Eq DescribeEffectivePolicyResponse Source # | |
Read DescribeEffectivePolicyResponse Source # | |
Show DescribeEffectivePolicyResponse Source # | |
Generic DescribeEffectivePolicyResponse Source # | |
NFData DescribeEffectivePolicyResponse Source # | |
Defined in Amazonka.Organizations.DescribeEffectivePolicy rnf :: DescribeEffectivePolicyResponse -> () # | |
type Rep DescribeEffectivePolicyResponse Source # | |
Defined in Amazonka.Organizations.DescribeEffectivePolicy type Rep DescribeEffectivePolicyResponse = D1 ('MetaData "DescribeEffectivePolicyResponse" "Amazonka.Organizations.DescribeEffectivePolicy" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DescribeEffectivePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "effectivePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EffectivePolicy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDescribeEffectivePolicyResponse Source #
Create a value of DescribeEffectivePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:effectivePolicy:DescribeEffectivePolicyResponse'
, describeEffectivePolicyResponse_effectivePolicy
- The contents of the effective policy.
$sel:httpStatus:DescribeEffectivePolicyResponse'
, describeEffectivePolicyResponse_httpStatus
- The response's http status code.
LeaveOrganization
data LeaveOrganization Source #
See: newLeaveOrganization
smart constructor.
Instances
newLeaveOrganization :: LeaveOrganization Source #
Create a value of LeaveOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data LeaveOrganizationResponse Source #
See: newLeaveOrganizationResponse
smart constructor.
Instances
newLeaveOrganizationResponse :: LeaveOrganizationResponse Source #
Create a value of LeaveOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
MoveAccount
data MoveAccount Source #
See: newMoveAccount
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> MoveAccount |
Create a value of MoveAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:MoveAccount'
, moveAccount_accountId
- The unique identifier (ID) of the account that you want to move.
The regex pattern for an account ID string requires exactly 12 digits.
$sel:sourceParentId:MoveAccount'
, moveAccount_sourceParentId
- 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.
$sel:destinationParentId:MoveAccount'
, moveAccount_destinationParentId
- 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.
data MoveAccountResponse Source #
See: newMoveAccountResponse
smart constructor.
Instances
Eq MoveAccountResponse Source # | |
Defined in Amazonka.Organizations.MoveAccount (==) :: MoveAccountResponse -> MoveAccountResponse -> Bool # (/=) :: MoveAccountResponse -> MoveAccountResponse -> Bool # | |
Read MoveAccountResponse Source # | |
Show MoveAccountResponse Source # | |
Defined in Amazonka.Organizations.MoveAccount showsPrec :: Int -> MoveAccountResponse -> ShowS # show :: MoveAccountResponse -> String # showList :: [MoveAccountResponse] -> ShowS # | |
Generic MoveAccountResponse Source # | |
Defined in Amazonka.Organizations.MoveAccount type Rep MoveAccountResponse :: Type -> Type # from :: MoveAccountResponse -> Rep MoveAccountResponse x # to :: Rep MoveAccountResponse x -> MoveAccountResponse # | |
NFData MoveAccountResponse Source # | |
Defined in Amazonka.Organizations.MoveAccount rnf :: MoveAccountResponse -> () # | |
type Rep MoveAccountResponse Source # | |
newMoveAccountResponse :: MoveAccountResponse Source #
Create a value of MoveAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListAccounts (Paginated)
data ListAccounts Source #
See: newListAccounts
smart constructor.
Instances
newListAccounts :: ListAccounts Source #
Create a value of ListAccounts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAccounts'
, listAccounts_nextToken
- 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.
$sel:maxResults:ListAccounts'
, listAccounts_maxResults
- 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.
data ListAccountsResponse Source #
See: newListAccountsResponse
smart constructor.
Instances
newListAccountsResponse Source #
Create a value of ListAccountsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accounts:ListAccountsResponse'
, listAccountsResponse_accounts
- A list of objects in the organization.
$sel:nextToken:ListAccounts'
, listAccountsResponse_nextToken
- 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
.
$sel:httpStatus:ListAccountsResponse'
, listAccountsResponse_httpStatus
- The response's http status code.
InviteAccountToOrganization
data InviteAccountToOrganization Source #
See: newInviteAccountToOrganization
smart constructor.
Instances
newInviteAccountToOrganization Source #
Create a value of InviteAccountToOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:notes:InviteAccountToOrganization'
, inviteAccountToOrganization_notes
- Additional information that you want to include in the generated email
to the recipient account owner.
$sel:tags:InviteAccountToOrganization'
, inviteAccountToOrganization_tags
- 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.
$sel:target:InviteAccountToOrganization'
, inviteAccountToOrganization_target
- 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
data InviteAccountToOrganizationResponse Source #
See: newInviteAccountToOrganizationResponse
smart constructor.
Instances
newInviteAccountToOrganizationResponse Source #
Create a value of InviteAccountToOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshake:InviteAccountToOrganizationResponse'
, inviteAccountToOrganizationResponse_handshake
- A structure that contains details about the handshake that is created to
support this invitation request.
$sel:httpStatus:InviteAccountToOrganizationResponse'
, inviteAccountToOrganizationResponse_httpStatus
- The response's http status code.
ListAWSServiceAccessForOrganization (Paginated)
data ListAWSServiceAccessForOrganization Source #
See: newListAWSServiceAccessForOrganization
smart constructor.
Instances
newListAWSServiceAccessForOrganization :: ListAWSServiceAccessForOrganization Source #
Create a value of ListAWSServiceAccessForOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAWSServiceAccessForOrganization'
, listAWSServiceAccessForOrganization_nextToken
- 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.
$sel:maxResults:ListAWSServiceAccessForOrganization'
, listAWSServiceAccessForOrganization_maxResults
- 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.
data ListAWSServiceAccessForOrganizationResponse Source #
See: newListAWSServiceAccessForOrganizationResponse
smart constructor.
Instances
newListAWSServiceAccessForOrganizationResponse Source #
:: Int |
|
-> ListAWSServiceAccessForOrganizationResponse |
Create a value of ListAWSServiceAccessForOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAWSServiceAccessForOrganization'
, listAWSServiceAccessForOrganizationResponse_nextToken
- 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
.
$sel:enabledServicePrincipals:ListAWSServiceAccessForOrganizationResponse'
, listAWSServiceAccessForOrganizationResponse_enabledServicePrincipals
- 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.
$sel:httpStatus:ListAWSServiceAccessForOrganizationResponse'
, listAWSServiceAccessForOrganizationResponse_httpStatus
- The response's http status code.
ListOrganizationalUnitsForParent (Paginated)
data ListOrganizationalUnitsForParent Source #
See: newListOrganizationalUnitsForParent
smart constructor.
Instances
newListOrganizationalUnitsForParent Source #
Create a value of ListOrganizationalUnitsForParent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListOrganizationalUnitsForParent'
, listOrganizationalUnitsForParent_nextToken
- 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.
$sel:maxResults:ListOrganizationalUnitsForParent'
, listOrganizationalUnitsForParent_maxResults
- 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.
$sel:parentId:ListOrganizationalUnitsForParent'
, listOrganizationalUnitsForParent_parentId
- 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.
data ListOrganizationalUnitsForParentResponse Source #
See: newListOrganizationalUnitsForParentResponse
smart constructor.
Instances
newListOrganizationalUnitsForParentResponse Source #
Create a value of ListOrganizationalUnitsForParentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListOrganizationalUnitsForParent'
, listOrganizationalUnitsForParentResponse_nextToken
- 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
.
$sel:organizationalUnits:ListOrganizationalUnitsForParentResponse'
, listOrganizationalUnitsForParentResponse_organizationalUnits
- A list of the OUs in the specified root or parent OU.
$sel:httpStatus:ListOrganizationalUnitsForParentResponse'
, listOrganizationalUnitsForParentResponse_httpStatus
- The response's http status code.
CancelHandshake
data CancelHandshake Source #
See: newCancelHandshake
smart constructor.
Instances
Create a value of CancelHandshake
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshakeId:CancelHandshake'
, cancelHandshake_handshakeId
- 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.
data CancelHandshakeResponse Source #
See: newCancelHandshakeResponse
smart constructor.
Instances
newCancelHandshakeResponse Source #
Create a value of CancelHandshakeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshake:CancelHandshakeResponse'
, cancelHandshakeResponse_handshake
- A structure that contains details about the handshake that you canceled.
$sel:httpStatus:CancelHandshakeResponse'
, cancelHandshakeResponse_httpStatus
- The response's http status code.
ListChildren (Paginated)
data ListChildren Source #
See: newListChildren
smart constructor.
Instances
Create a value of ListChildren
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListChildren'
, listChildren_nextToken
- 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.
$sel:maxResults:ListChildren'
, listChildren_maxResults
- 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.
$sel:parentId:ListChildren'
, listChildren_parentId
- 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.
$sel:childType:ListChildren'
, listChildren_childType
- Filters the output to include only the specified child type.
data ListChildrenResponse Source #
See: newListChildrenResponse
smart constructor.
Instances
newListChildrenResponse Source #
Create a value of ListChildrenResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:children:ListChildrenResponse'
, listChildrenResponse_children
- The list of children of the specified parent container.
$sel:nextToken:ListChildren'
, listChildrenResponse_nextToken
- 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
.
$sel:httpStatus:ListChildrenResponse'
, listChildrenResponse_httpStatus
- The response's http status code.
ListDelegatedAdministrators (Paginated)
data ListDelegatedAdministrators Source #
See: newListDelegatedAdministrators
smart constructor.
Instances
newListDelegatedAdministrators :: ListDelegatedAdministrators Source #
Create a value of ListDelegatedAdministrators
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:servicePrincipal:ListDelegatedAdministrators'
, listDelegatedAdministrators_servicePrincipal
- 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.
$sel:nextToken:ListDelegatedAdministrators'
, listDelegatedAdministrators_nextToken
- 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.
$sel:maxResults:ListDelegatedAdministrators'
, listDelegatedAdministrators_maxResults
- 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.
data ListDelegatedAdministratorsResponse Source #
See: newListDelegatedAdministratorsResponse
smart constructor.
Instances
newListDelegatedAdministratorsResponse Source #
Create a value of ListDelegatedAdministratorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:delegatedAdministrators:ListDelegatedAdministratorsResponse'
, listDelegatedAdministratorsResponse_delegatedAdministrators
- The list of delegated administrators in your organization.
$sel:nextToken:ListDelegatedAdministrators'
, listDelegatedAdministratorsResponse_nextToken
- 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
.
$sel:httpStatus:ListDelegatedAdministratorsResponse'
, listDelegatedAdministratorsResponse_httpStatus
- The response's http status code.
DeletePolicy
data DeletePolicy Source #
See: newDeletePolicy
smart constructor.
Instances
Create a value of DeletePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyId:DeletePolicy'
, deletePolicy_policyId
- 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 (_).
data DeletePolicyResponse Source #
See: newDeletePolicyResponse
smart constructor.
Instances
Eq DeletePolicyResponse Source # | |
Defined in Amazonka.Organizations.DeletePolicy (==) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool # (/=) :: DeletePolicyResponse -> DeletePolicyResponse -> Bool # | |
Read DeletePolicyResponse Source # | |
Show DeletePolicyResponse Source # | |
Defined in Amazonka.Organizations.DeletePolicy showsPrec :: Int -> DeletePolicyResponse -> ShowS # show :: DeletePolicyResponse -> String # showList :: [DeletePolicyResponse] -> ShowS # | |
Generic DeletePolicyResponse Source # | |
Defined in Amazonka.Organizations.DeletePolicy type Rep DeletePolicyResponse :: Type -> Type # from :: DeletePolicyResponse -> Rep DeletePolicyResponse x # to :: Rep DeletePolicyResponse x -> DeletePolicyResponse # | |
NFData DeletePolicyResponse Source # | |
Defined in Amazonka.Organizations.DeletePolicy rnf :: DeletePolicyResponse -> () # | |
type Rep DeletePolicyResponse Source # | |
Defined in Amazonka.Organizations.DeletePolicy |
newDeletePolicyResponse :: DeletePolicyResponse Source #
Create a value of DeletePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdatePolicy
data UpdatePolicy Source #
See: newUpdatePolicy
smart constructor.
Instances
Create a value of UpdatePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:UpdatePolicy'
, updatePolicy_content
- 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.
$sel:name:UpdatePolicy'
, updatePolicy_name
- 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.
$sel:description:UpdatePolicy'
, updatePolicy_description
- If provided, the new description for the policy.
$sel:policyId:UpdatePolicy'
, updatePolicy_policyId
- 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 (_).
data UpdatePolicyResponse Source #
See: newUpdatePolicyResponse
smart constructor.
Instances
newUpdatePolicyResponse Source #
Create a value of UpdatePolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policy:UpdatePolicyResponse'
, updatePolicyResponse_policy
- A structure that contains details about the updated policy, showing the
requested changes.
$sel:httpStatus:UpdatePolicyResponse'
, updatePolicyResponse_httpStatus
- The response's http status code.
EnablePolicyType
data EnablePolicyType Source #
See: newEnablePolicyType
smart constructor.
Instances
:: Text | |
-> PolicyType | |
-> EnablePolicyType |
Create a value of EnablePolicyType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rootId:EnablePolicyType'
, enablePolicyType_rootId
- 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.
$sel:policyType:EnablePolicyType'
, enablePolicyType_policyType
- The policy type that you want to enable. You can specify one of the
following values:
data EnablePolicyTypeResponse Source #
See: newEnablePolicyTypeResponse
smart constructor.
Instances
newEnablePolicyTypeResponse Source #
Create a value of EnablePolicyTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:root:EnablePolicyTypeResponse'
, enablePolicyTypeResponse_root
- A structure that shows the root with the updated list of enabled policy
types.
$sel:httpStatus:EnablePolicyTypeResponse'
, enablePolicyTypeResponse_httpStatus
- The response's http status code.
DisablePolicyType
data DisablePolicyType Source #
See: newDisablePolicyType
smart constructor.
Instances
:: Text | |
-> PolicyType | |
-> DisablePolicyType |
Create a value of DisablePolicyType
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rootId:DisablePolicyType'
, disablePolicyType_rootId
- 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.
$sel:policyType:DisablePolicyType'
, disablePolicyType_policyType
- The policy type that you want to disable in this root. You can specify
one of the following values:
data DisablePolicyTypeResponse Source #
See: newDisablePolicyTypeResponse
smart constructor.
Instances
newDisablePolicyTypeResponse Source #
Create a value of DisablePolicyTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:root:DisablePolicyTypeResponse'
, disablePolicyTypeResponse_root
- A structure that shows the root with the updated list of enabled policy
types.
$sel:httpStatus:DisablePolicyTypeResponse'
, disablePolicyTypeResponse_httpStatus
- The response's http status code.
DescribeCreateAccountStatus
data DescribeCreateAccountStatus Source #
See: newDescribeCreateAccountStatus
smart constructor.
Instances
newDescribeCreateAccountStatus Source #
Create a value of DescribeCreateAccountStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createAccountRequestId:DescribeCreateAccountStatus'
, describeCreateAccountStatus_createAccountRequestId
- 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.
data DescribeCreateAccountStatusResponse Source #
See: newDescribeCreateAccountStatusResponse
smart constructor.
Instances
newDescribeCreateAccountStatusResponse Source #
Create a value of DescribeCreateAccountStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createAccountStatus:DescribeCreateAccountStatusResponse'
, describeCreateAccountStatusResponse_createAccountStatus
- A structure that contains the current status of an account creation
request.
$sel:httpStatus:DescribeCreateAccountStatusResponse'
, describeCreateAccountStatusResponse_httpStatus
- The response's http status code.
CreateOrganizationalUnit
data CreateOrganizationalUnit Source #
See: newCreateOrganizationalUnit
smart constructor.
Instances
newCreateOrganizationalUnit Source #
:: Text | |
-> Text | |
-> CreateOrganizationalUnit |
Create a value of CreateOrganizationalUnit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateOrganizationalUnit'
, createOrganizationalUnit_tags
- 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.
$sel:parentId:CreateOrganizationalUnit'
, createOrganizationalUnit_parentId
- 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.
$sel:name:CreateOrganizationalUnit'
, createOrganizationalUnit_name
- The friendly name to assign to the new OU.
data CreateOrganizationalUnitResponse Source #
See: newCreateOrganizationalUnitResponse
smart constructor.
Instances
Eq CreateOrganizationalUnitResponse Source # | |
Read CreateOrganizationalUnitResponse Source # | |
Show CreateOrganizationalUnitResponse Source # | |
Generic CreateOrganizationalUnitResponse Source # | |
NFData CreateOrganizationalUnitResponse Source # | |
Defined in Amazonka.Organizations.CreateOrganizationalUnit rnf :: CreateOrganizationalUnitResponse -> () # | |
type Rep CreateOrganizationalUnitResponse Source # | |
Defined in Amazonka.Organizations.CreateOrganizationalUnit type Rep CreateOrganizationalUnitResponse = D1 ('MetaData "CreateOrganizationalUnitResponse" "Amazonka.Organizations.CreateOrganizationalUnit" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "CreateOrganizationalUnitResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrganizationalUnit)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateOrganizationalUnitResponse Source #
Create a value of CreateOrganizationalUnitResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationalUnit:CreateOrganizationalUnitResponse'
, createOrganizationalUnitResponse_organizationalUnit
- A structure that contains details about the newly created OU.
$sel:httpStatus:CreateOrganizationalUnitResponse'
, createOrganizationalUnitResponse_httpStatus
- The response's http status code.
ListAccountsForParent (Paginated)
data ListAccountsForParent Source #
See: newListAccountsForParent
smart constructor.
Instances
newListAccountsForParent Source #
Create a value of ListAccountsForParent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListAccountsForParent'
, listAccountsForParent_nextToken
- 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.
$sel:maxResults:ListAccountsForParent'
, listAccountsForParent_maxResults
- 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.
$sel:parentId:ListAccountsForParent'
, listAccountsForParent_parentId
- The unique identifier (ID) for the parent root or organization unit (OU)
whose accounts you want to list.
data ListAccountsForParentResponse Source #
See: newListAccountsForParentResponse
smart constructor.
Instances
newListAccountsForParentResponse Source #
Create a value of ListAccountsForParentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accounts:ListAccountsForParentResponse'
, listAccountsForParentResponse_accounts
- A list of the accounts in the specified root or OU.
$sel:nextToken:ListAccountsForParent'
, listAccountsForParentResponse_nextToken
- 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
.
$sel:httpStatus:ListAccountsForParentResponse'
, listAccountsForParentResponse_httpStatus
- The response's http status code.
DetachPolicy
data DetachPolicy Source #
See: newDetachPolicy
smart constructor.
Instances
Create a value of DetachPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyId:DetachPolicy'
, detachPolicy_policyId
- 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 (_).
$sel:targetId:DetachPolicy'
, detachPolicy_targetId
- 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.
data DetachPolicyResponse Source #
See: newDetachPolicyResponse
smart constructor.
Instances
Eq DetachPolicyResponse Source # | |
Defined in Amazonka.Organizations.DetachPolicy (==) :: DetachPolicyResponse -> DetachPolicyResponse -> Bool # (/=) :: DetachPolicyResponse -> DetachPolicyResponse -> Bool # | |
Read DetachPolicyResponse Source # | |
Show DetachPolicyResponse Source # | |
Defined in Amazonka.Organizations.DetachPolicy showsPrec :: Int -> DetachPolicyResponse -> ShowS # show :: DetachPolicyResponse -> String # showList :: [DetachPolicyResponse] -> ShowS # | |
Generic DetachPolicyResponse Source # | |
Defined in Amazonka.Organizations.DetachPolicy type Rep DetachPolicyResponse :: Type -> Type # from :: DetachPolicyResponse -> Rep DetachPolicyResponse x # to :: Rep DetachPolicyResponse x -> DetachPolicyResponse # | |
NFData DetachPolicyResponse Source # | |
Defined in Amazonka.Organizations.DetachPolicy rnf :: DetachPolicyResponse -> () # | |
type Rep DetachPolicyResponse Source # | |
Defined in Amazonka.Organizations.DetachPolicy |
newDetachPolicyResponse :: DetachPolicyResponse Source #
Create a value of DetachPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RemoveAccountFromOrganization
data RemoveAccountFromOrganization Source #
See: newRemoveAccountFromOrganization
smart constructor.
Instances
newRemoveAccountFromOrganization Source #
Create a value of RemoveAccountFromOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:RemoveAccountFromOrganization'
, removeAccountFromOrganization_accountId
- 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.
data RemoveAccountFromOrganizationResponse Source #
See: newRemoveAccountFromOrganizationResponse
smart constructor.
Instances
Eq RemoveAccountFromOrganizationResponse Source # | |
Read RemoveAccountFromOrganizationResponse Source # | |
Show RemoveAccountFromOrganizationResponse Source # | |
Generic RemoveAccountFromOrganizationResponse Source # | |
Defined in Amazonka.Organizations.RemoveAccountFromOrganization type Rep RemoveAccountFromOrganizationResponse :: Type -> Type # | |
NFData RemoveAccountFromOrganizationResponse Source # | |
type Rep RemoveAccountFromOrganizationResponse Source # | |
Defined in Amazonka.Organizations.RemoveAccountFromOrganization type Rep RemoveAccountFromOrganizationResponse = D1 ('MetaData "RemoveAccountFromOrganizationResponse" "Amazonka.Organizations.RemoveAccountFromOrganization" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "RemoveAccountFromOrganizationResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newRemoveAccountFromOrganizationResponse :: RemoveAccountFromOrganizationResponse Source #
Create a value of RemoveAccountFromOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateGovCloudAccount
data CreateGovCloudAccount Source #
See: newCreateGovCloudAccount
smart constructor.
CreateGovCloudAccount' (Maybe IAMUserAccessToBilling) (Maybe Text) (Maybe [Tag]) (Sensitive Text) (Sensitive Text) |
Instances
newCreateGovCloudAccount Source #
:: Text | |
-> Text | |
-> CreateGovCloudAccount |
Create a value of CreateGovCloudAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamUserAccessToBilling:CreateGovCloudAccount'
, createGovCloudAccount_iamUserAccessToBilling
- 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.
$sel:roleName:CreateGovCloudAccount'
, createGovCloudAccount_roleName
- (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: =,.@-
$sel:tags:CreateGovCloudAccount'
, createGovCloudAccount_tags
- 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.
$sel:email:CreateGovCloudAccount'
, createGovCloudAccount_email
- 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.
$sel:accountName:CreateGovCloudAccount'
, createGovCloudAccount_accountName
- The friendly name of the member account.
data CreateGovCloudAccountResponse Source #
See: newCreateGovCloudAccountResponse
smart constructor.
Instances
newCreateGovCloudAccountResponse Source #
Create a value of CreateGovCloudAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createAccountStatus:CreateGovCloudAccountResponse'
, createGovCloudAccountResponse_createAccountStatus
- Undocumented member.
$sel:httpStatus:CreateGovCloudAccountResponse'
, createGovCloudAccountResponse_httpStatus
- The response's http status code.
EnableAWSServiceAccess
data EnableAWSServiceAccess Source #
See: newEnableAWSServiceAccess
smart constructor.
Instances
newEnableAWSServiceAccess Source #
Create a value of EnableAWSServiceAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:servicePrincipal:EnableAWSServiceAccess'
, enableAWSServiceAccess_servicePrincipal
- 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
.
data EnableAWSServiceAccessResponse Source #
See: newEnableAWSServiceAccessResponse
smart constructor.
Instances
newEnableAWSServiceAccessResponse :: EnableAWSServiceAccessResponse Source #
Create a value of EnableAWSServiceAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeOrganizationalUnit
data DescribeOrganizationalUnit Source #
See: newDescribeOrganizationalUnit
smart constructor.
Instances
newDescribeOrganizationalUnit Source #
Create a value of DescribeOrganizationalUnit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationalUnitId:DescribeOrganizationalUnit'
, describeOrganizationalUnit_organizationalUnitId
- 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.
data DescribeOrganizationalUnitResponse Source #
See: newDescribeOrganizationalUnitResponse
smart constructor.
Instances
newDescribeOrganizationalUnitResponse Source #
Create a value of DescribeOrganizationalUnitResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationalUnit:DescribeOrganizationalUnitResponse'
, describeOrganizationalUnitResponse_organizationalUnit
- A structure that contains details about the specified OU.
$sel:httpStatus:DescribeOrganizationalUnitResponse'
, describeOrganizationalUnitResponse_httpStatus
- The response's http status code.
ListParents (Paginated)
data ListParents Source #
See: newListParents
smart constructor.
Instances
Create a value of ListParents
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListParents'
, listParents_nextToken
- 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.
$sel:maxResults:ListParents'
, listParents_maxResults
- 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.
$sel:childId:ListParents'
, listParents_childId
- 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.
data ListParentsResponse Source #
See: newListParentsResponse
smart constructor.
Instances
newListParentsResponse Source #
Create a value of ListParentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListParents'
, listParentsResponse_nextToken
- 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
.
$sel:parents:ListParentsResponse'
, listParentsResponse_parents
- A list of parents for the specified child account or OU.
$sel:httpStatus:ListParentsResponse'
, listParentsResponse_httpStatus
- The response's http status code.
CreateAccount
data CreateAccount Source #
See: newCreateAccount
smart constructor.
CreateAccount' (Maybe IAMUserAccessToBilling) (Maybe Text) (Maybe [Tag]) (Sensitive Text) (Sensitive Text) |
Instances
Create a value of CreateAccount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamUserAccessToBilling:CreateAccount'
, createAccount_iamUserAccessToBilling
- 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.
$sel:roleName:CreateAccount'
, createAccount_roleName
- (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:
- Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide
- 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: =,.@-
$sel:tags:CreateAccount'
, createAccount_tags
- 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.
$sel:email:CreateAccount'
, createAccount_email
- 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.
$sel:accountName:CreateAccount'
, createAccount_accountName
- The friendly name of the member account.
data CreateAccountResponse Source #
See: newCreateAccountResponse
smart constructor.
Instances
newCreateAccountResponse Source #
Create a value of CreateAccountResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createAccountStatus:CreateAccountResponse'
, createAccountResponse_createAccountStatus
- 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.
$sel:httpStatus:CreateAccountResponse'
, createAccountResponse_httpStatus
- The response's http status code.
DeregisterDelegatedAdministrator
data DeregisterDelegatedAdministrator Source #
See: newDeregisterDelegatedAdministrator
smart constructor.
Instances
newDeregisterDelegatedAdministrator Source #
Create a value of DeregisterDelegatedAdministrator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:DeregisterDelegatedAdministrator'
, deregisterDelegatedAdministrator_accountId
- The account ID number of the member account in the organization that you
want to deregister as a delegated administrator.
$sel:servicePrincipal:DeregisterDelegatedAdministrator'
, deregisterDelegatedAdministrator_servicePrincipal
- 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.
data DeregisterDelegatedAdministratorResponse Source #
See: newDeregisterDelegatedAdministratorResponse
smart constructor.
Instances
Eq DeregisterDelegatedAdministratorResponse Source # | |
Read DeregisterDelegatedAdministratorResponse Source # | |
Show DeregisterDelegatedAdministratorResponse Source # | |
Generic DeregisterDelegatedAdministratorResponse Source # | |
Defined in Amazonka.Organizations.DeregisterDelegatedAdministrator type Rep DeregisterDelegatedAdministratorResponse :: Type -> Type # | |
NFData DeregisterDelegatedAdministratorResponse Source # | |
type Rep DeregisterDelegatedAdministratorResponse Source # | |
Defined in Amazonka.Organizations.DeregisterDelegatedAdministrator type Rep DeregisterDelegatedAdministratorResponse = D1 ('MetaData "DeregisterDelegatedAdministratorResponse" "Amazonka.Organizations.DeregisterDelegatedAdministrator" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DeregisterDelegatedAdministratorResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeregisterDelegatedAdministratorResponse :: DeregisterDelegatedAdministratorResponse Source #
Create a value of DeregisterDelegatedAdministratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceId:TagResource'
, tagResource_resourceId
- The ID of the resource to add a tag to.
$sel:tags:TagResource'
, tagResource_tags
- 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.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Eq TagResourceResponse Source # | |
Defined in Amazonka.Organizations.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
Read TagResourceResponse Source # | |
Show TagResourceResponse Source # | |
Defined in Amazonka.Organizations.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
Generic TagResourceResponse Source # | |
Defined in Amazonka.Organizations.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.Organizations.TagResource rnf :: TagResourceResponse -> () # | |
type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListCreateAccountStatus (Paginated)
data ListCreateAccountStatus Source #
See: newListCreateAccountStatus
smart constructor.
Instances
newListCreateAccountStatus :: ListCreateAccountStatus Source #
Create a value of ListCreateAccountStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:states:ListCreateAccountStatus'
, listCreateAccountStatus_states
- 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.
$sel:nextToken:ListCreateAccountStatus'
, listCreateAccountStatus_nextToken
- 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.
$sel:maxResults:ListCreateAccountStatus'
, listCreateAccountStatus_maxResults
- 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.
data ListCreateAccountStatusResponse Source #
See: newListCreateAccountStatusResponse
smart constructor.
Instances
newListCreateAccountStatusResponse Source #
Create a value of ListCreateAccountStatusResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createAccountStatuses:ListCreateAccountStatusResponse'
, listCreateAccountStatusResponse_createAccountStatuses
- 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.
$sel:nextToken:ListCreateAccountStatus'
, listCreateAccountStatusResponse_nextToken
- 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
.
$sel:httpStatus:ListCreateAccountStatusResponse'
, listCreateAccountStatusResponse_httpStatus
- The response's http status code.
ListTargetsForPolicy (Paginated)
data ListTargetsForPolicy Source #
See: newListTargetsForPolicy
smart constructor.
Instances
newListTargetsForPolicy Source #
Create a value of ListTargetsForPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListTargetsForPolicy'
, listTargetsForPolicy_nextToken
- 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.
$sel:maxResults:ListTargetsForPolicy'
, listTargetsForPolicy_maxResults
- 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.
$sel:policyId:ListTargetsForPolicy'
, listTargetsForPolicy_policyId
- 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 (_).
data ListTargetsForPolicyResponse Source #
See: newListTargetsForPolicyResponse
smart constructor.
Instances
newListTargetsForPolicyResponse Source #
Create a value of ListTargetsForPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListTargetsForPolicy'
, listTargetsForPolicyResponse_nextToken
- 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
.
$sel:targets:ListTargetsForPolicyResponse'
, listTargetsForPolicyResponse_targets
- A list of structures, each of which contains details about one of the
entities to which the specified policy is attached.
$sel:httpStatus:ListTargetsForPolicyResponse'
, listTargetsForPolicyResponse_httpStatus
- The response's http status code.
DeclineHandshake
data DeclineHandshake Source #
See: newDeclineHandshake
smart constructor.
Instances
Create a value of DeclineHandshake
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshakeId:DeclineHandshake'
, declineHandshake_handshakeId
- 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.
data DeclineHandshakeResponse Source #
See: newDeclineHandshakeResponse
smart constructor.
Instances
newDeclineHandshakeResponse Source #
Create a value of DeclineHandshakeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshake:DeclineHandshakeResponse'
, declineHandshakeResponse_handshake
- A structure that contains details about the declined handshake. The
state is updated to show the value DECLINED
.
$sel:httpStatus:DeclineHandshakeResponse'
, declineHandshakeResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceId:UntagResource'
, untagResource_resourceId
- 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
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of keys for tags to remove from the specified resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Eq UntagResourceResponse Source # | |
Defined in Amazonka.Organizations.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.Organizations.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
Generic UntagResourceResponse Source # | |
Defined in Amazonka.Organizations.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.Organizations.UntagResource rnf :: UntagResourceResponse -> () # | |
type Rep UntagResourceResponse Source # | |
Defined in Amazonka.Organizations.UntagResource |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AttachPolicy
data AttachPolicy Source #
See: newAttachPolicy
smart constructor.
Instances
Create a value of AttachPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:policyId:AttachPolicy'
, attachPolicy_policyId
- 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 (_).
$sel:targetId:AttachPolicy'
, attachPolicy_targetId
- 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.
data AttachPolicyResponse Source #
See: newAttachPolicyResponse
smart constructor.
Instances
Eq AttachPolicyResponse Source # | |
Defined in Amazonka.Organizations.AttachPolicy (==) :: AttachPolicyResponse -> AttachPolicyResponse -> Bool # (/=) :: AttachPolicyResponse -> AttachPolicyResponse -> Bool # | |
Read AttachPolicyResponse Source # | |
Show AttachPolicyResponse Source # | |
Defined in Amazonka.Organizations.AttachPolicy showsPrec :: Int -> AttachPolicyResponse -> ShowS # show :: AttachPolicyResponse -> String # showList :: [AttachPolicyResponse] -> ShowS # | |
Generic AttachPolicyResponse Source # | |
Defined in Amazonka.Organizations.AttachPolicy type Rep AttachPolicyResponse :: Type -> Type # from :: AttachPolicyResponse -> Rep AttachPolicyResponse x # to :: Rep AttachPolicyResponse x -> AttachPolicyResponse # | |
NFData AttachPolicyResponse Source # | |
Defined in Amazonka.Organizations.AttachPolicy rnf :: AttachPolicyResponse -> () # | |
type Rep AttachPolicyResponse Source # | |
Defined in Amazonka.Organizations.AttachPolicy |
newAttachPolicyResponse :: AttachPolicyResponse Source #
Create a value of AttachPolicyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListPoliciesForTarget (Paginated)
data ListPoliciesForTarget Source #
See: newListPoliciesForTarget
smart constructor.
Instances
newListPoliciesForTarget Source #
:: Text | |
-> PolicyType | |
-> ListPoliciesForTarget |
Create a value of ListPoliciesForTarget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPoliciesForTarget'
, listPoliciesForTarget_nextToken
- 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.
$sel:maxResults:ListPoliciesForTarget'
, listPoliciesForTarget_maxResults
- 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.
$sel:targetId:ListPoliciesForTarget'
, listPoliciesForTarget_targetId
- 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.
$sel:filter':ListPoliciesForTarget'
, listPoliciesForTarget_filter
- The type of policy that you want to include in the returned list. You
must specify one of the following values:
data ListPoliciesForTargetResponse Source #
See: newListPoliciesForTargetResponse
smart constructor.
Instances
newListPoliciesForTargetResponse Source #
Create a value of ListPoliciesForTargetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListPoliciesForTarget'
, listPoliciesForTargetResponse_nextToken
- 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
.
$sel:policies:ListPoliciesForTargetResponse'
, listPoliciesForTargetResponse_policies
- The list of policies that match the criteria in the request.
$sel:httpStatus:ListPoliciesForTargetResponse'
, listPoliciesForTargetResponse_httpStatus
- The response's http status code.
DescribeOrganization
data DescribeOrganization Source #
See: newDescribeOrganization
smart constructor.
Instances
newDescribeOrganization :: DescribeOrganization Source #
Create a value of DescribeOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeOrganizationResponse Source #
See: newDescribeOrganizationResponse
smart constructor.
Instances
newDescribeOrganizationResponse Source #
Create a value of DescribeOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organization:DescribeOrganizationResponse'
, describeOrganizationResponse_organization
- 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.
$sel:httpStatus:DescribeOrganizationResponse'
, describeOrganizationResponse_httpStatus
- The response's http status code.
ListHandshakesForOrganization (Paginated)
data ListHandshakesForOrganization Source #
See: newListHandshakesForOrganization
smart constructor.
Instances
newListHandshakesForOrganization :: ListHandshakesForOrganization Source #
Create a value of ListHandshakesForOrganization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextToken:ListHandshakesForOrganization'
, listHandshakesForOrganization_nextToken
- 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.
$sel:filter':ListHandshakesForOrganization'
, listHandshakesForOrganization_filter
- 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.
$sel:maxResults:ListHandshakesForOrganization'
, listHandshakesForOrganization_maxResults
- 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.
data ListHandshakesForOrganizationResponse Source #
See: newListHandshakesForOrganizationResponse
smart constructor.
Instances
newListHandshakesForOrganizationResponse Source #
Create a value of ListHandshakesForOrganizationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:handshakes:ListHandshakesForOrganizationResponse'
, listHandshakesForOrganizationResponse_handshakes
- A list of Handshake objects with details about each of the handshakes
that are associated with an organization.
$sel:nextToken:ListHandshakesForOrganization'
, listHandshakesForOrganizationResponse_nextToken
- 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
.
$sel:httpStatus:ListHandshakesForOrganizationResponse'
, listHandshakesForOrganizationResponse_httpStatus
- The response's http status code.
RegisterDelegatedAdministrator
data RegisterDelegatedAdministrator Source #
See: newRegisterDelegatedAdministrator
smart constructor.
Instances
newRegisterDelegatedAdministrator Source #
Create a value of RegisterDelegatedAdministrator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountId:RegisterDelegatedAdministrator'
, registerDelegatedAdministrator_accountId
- The account ID number of the member account in the organization to
register as a delegated administrator.
$sel:servicePrincipal:RegisterDelegatedAdministrator'
, registerDelegatedAdministrator_servicePrincipal
- The service principal of the AWS service for which you want to make the
member account a delegated administrator.
data RegisterDelegatedAdministratorResponse Source #
See: newRegisterDelegatedAdministratorResponse
smart constructor.
Instances
Eq RegisterDelegatedAdministratorResponse Source # | |
Read RegisterDelegatedAdministratorResponse Source # | |
Show RegisterDelegatedAdministratorResponse Source # | |
Generic RegisterDelegatedAdministratorResponse Source # | |
Defined in Amazonka.Organizations.RegisterDelegatedAdministrator type Rep RegisterDelegatedAdministratorResponse :: Type -> Type # | |
NFData RegisterDelegatedAdministratorResponse Source # | |
type Rep RegisterDelegatedAdministratorResponse Source # | |
Defined in Amazonka.Organizations.RegisterDelegatedAdministrator type Rep RegisterDelegatedAdministratorResponse = D1 ('MetaData "RegisterDelegatedAdministratorResponse" "Amazonka.Organizations.RegisterDelegatedAdministrator" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "RegisterDelegatedAdministratorResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newRegisterDelegatedAdministratorResponse :: RegisterDelegatedAdministratorResponse Source #
Create a value of RegisterDelegatedAdministratorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteOrganizationalUnit
data DeleteOrganizationalUnit Source #
See: newDeleteOrganizationalUnit
smart constructor.
Instances
newDeleteOrganizationalUnit Source #
Create a value of DeleteOrganizationalUnit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationalUnitId:DeleteOrganizationalUnit'
, deleteOrganizationalUnit_organizationalUnitId
- 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.
data DeleteOrganizationalUnitResponse Source #
See: newDeleteOrganizationalUnitResponse
smart constructor.
Instances
Eq DeleteOrganizationalUnitResponse Source # | |
Read DeleteOrganizationalUnitResponse Source # | |
Show DeleteOrganizationalUnitResponse Source # | |
Generic DeleteOrganizationalUnitResponse Source # | |
NFData DeleteOrganizationalUnitResponse Source # | |
Defined in Amazonka.Organizations.DeleteOrganizationalUnit rnf :: DeleteOrganizationalUnitResponse -> () # | |
type Rep DeleteOrganizationalUnitResponse Source # | |
Defined in Amazonka.Organizations.DeleteOrganizationalUnit type Rep DeleteOrganizationalUnitResponse = D1 ('MetaData "DeleteOrganizationalUnitResponse" "Amazonka.Organizations.DeleteOrganizationalUnit" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DeleteOrganizationalUnitResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteOrganizationalUnitResponse :: DeleteOrganizationalUnitResponse Source #
Create a value of DeleteOrganizationalUnitResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateOrganizationalUnit
data UpdateOrganizationalUnit Source #
See: newUpdateOrganizationalUnit
smart constructor.
Instances
newUpdateOrganizationalUnit Source #
Create a value of UpdateOrganizationalUnit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:UpdateOrganizationalUnit'
, updateOrganizationalUnit_name
- 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.
$sel:organizationalUnitId:UpdateOrganizationalUnit'
, updateOrganizationalUnit_organizationalUnitId
- 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.
data UpdateOrganizationalUnitResponse Source #
See: newUpdateOrganizationalUnitResponse
smart constructor.
Instances
Eq UpdateOrganizationalUnitResponse Source # | |
Read UpdateOrganizationalUnitResponse Source # | |
Show UpdateOrganizationalUnitResponse Source # | |
Generic UpdateOrganizationalUnitResponse Source # | |
NFData UpdateOrganizationalUnitResponse Source # | |
Defined in Amazonka.Organizations.UpdateOrganizationalUnit rnf :: UpdateOrganizationalUnitResponse -> () # | |
type Rep UpdateOrganizationalUnitResponse Source # | |
Defined in Amazonka.Organizations.UpdateOrganizationalUnit type Rep UpdateOrganizationalUnitResponse = D1 ('MetaData "UpdateOrganizationalUnitResponse" "Amazonka.Organizations.UpdateOrganizationalUnit" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "UpdateOrganizationalUnitResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationalUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrganizationalUnit)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateOrganizationalUnitResponse Source #
Create a value of UpdateOrganizationalUnitResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:organizationalUnit:UpdateOrganizationalUnitResponse'
, updateOrganizationalUnitResponse_organizationalUnit
- A structure that contains the details about the specified OU, including
its new name.
$sel:httpStatus:UpdateOrganizationalUnitResponse'
, updateOrganizationalUnitResponse_httpStatus
- The response's http status code.
Types
AccountJoinedMethod
newtype AccountJoinedMethod Source #
pattern AccountJoinedMethod_CREATED :: AccountJoinedMethod | |
pattern AccountJoinedMethod_INVITED :: AccountJoinedMethod |
Instances
AccountStatus
newtype AccountStatus Source #
pattern AccountStatus_ACTIVE :: AccountStatus | |
pattern AccountStatus_SUSPENDED :: AccountStatus |
Instances
ActionType
newtype ActionType Source #
pattern ActionType_ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE :: ActionType | |
pattern ActionType_APPROVE_ALL_FEATURES :: ActionType | |
pattern ActionType_ENABLE_ALL_FEATURES :: ActionType | |
pattern ActionType_INVITE :: ActionType |
Instances
ChildType
pattern ChildType_ACCOUNT :: ChildType | |
pattern ChildType_ORGANIZATIONAL_UNIT :: ChildType |
Instances
CreateAccountFailureReason
newtype CreateAccountFailureReason Source #
Instances
CreateAccountState
newtype CreateAccountState Source #
pattern CreateAccountState_FAILED :: CreateAccountState | |
pattern CreateAccountState_IN_PROGRESS :: CreateAccountState | |
pattern CreateAccountState_SUCCEEDED :: CreateAccountState |
Instances
EffectivePolicyType
newtype EffectivePolicyType Source #
Instances
HandshakePartyType
newtype HandshakePartyType Source #
pattern HandshakePartyType_ACCOUNT :: HandshakePartyType | |
pattern HandshakePartyType_EMAIL :: HandshakePartyType | |
pattern HandshakePartyType_ORGANIZATION :: HandshakePartyType |
Instances
HandshakeResourceType
newtype HandshakeResourceType Source #
Instances
HandshakeState
newtype HandshakeState Source #
pattern HandshakeState_ACCEPTED :: HandshakeState | |
pattern HandshakeState_CANCELED :: HandshakeState | |
pattern HandshakeState_DECLINED :: HandshakeState | |
pattern HandshakeState_EXPIRED :: HandshakeState | |
pattern HandshakeState_OPEN :: HandshakeState | |
pattern HandshakeState_REQUESTED :: HandshakeState |
Instances
IAMUserAccessToBilling
newtype IAMUserAccessToBilling Source #
pattern IAMUserAccessToBilling_ALLOW :: IAMUserAccessToBilling | |
pattern IAMUserAccessToBilling_DENY :: IAMUserAccessToBilling |
Instances
OrganizationFeatureSet
newtype OrganizationFeatureSet Source #
pattern OrganizationFeatureSet_ALL :: OrganizationFeatureSet | |
pattern OrganizationFeatureSet_CONSOLIDATED_BILLING :: OrganizationFeatureSet |
Instances
ParentType
newtype ParentType Source #
pattern ParentType_ORGANIZATIONAL_UNIT :: ParentType | |
pattern ParentType_ROOT :: ParentType |
Instances
PolicyType
newtype PolicyType Source #
pattern PolicyType_AISERVICES_OPT_OUT_POLICY :: PolicyType | |
pattern PolicyType_BACKUP_POLICY :: PolicyType | |
pattern PolicyType_SERVICE_CONTROL_POLICY :: PolicyType | |
pattern PolicyType_TAG_POLICY :: PolicyType |
Instances
PolicyTypeStatus
newtype PolicyTypeStatus Source #
pattern PolicyTypeStatus_ENABLED :: PolicyTypeStatus | |
pattern PolicyTypeStatus_PENDING_DISABLE :: PolicyTypeStatus | |
pattern PolicyTypeStatus_PENDING_ENABLE :: PolicyTypeStatus |
Instances
TargetType
newtype TargetType Source #
pattern TargetType_ACCOUNT :: TargetType | |
pattern TargetType_ORGANIZATIONAL_UNIT :: TargetType | |
pattern TargetType_ROOT :: TargetType |
Instances
Account
Contains information about an AWS account that is a member of an organization.
See: newAccount
smart constructor.
Account' (Maybe AccountStatus) (Maybe AccountJoinedMethod) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) |
Instances
newAccount :: Account Source #
Create a value of Account
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:Account'
, account_status
- The status of the account in the organization.
$sel:joinedMethod:Account'
, account_joinedMethod
- The method by which the account joined the organization.
$sel:email:Account'
, account_email
- 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.
$sel:arn:Account'
, account_arn
- 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.
$sel:joinedTimestamp:Account'
, account_joinedTimestamp
- The date the account became a part of the organization.
$sel:name:Account'
, account_name
- 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.
$sel:id:Account'
, account_id
- The unique identifier (ID) of the account.
The regex pattern for an account ID string requires exactly 12 digits.
Child
Contains a list of child entities, either OUs or accounts.
See: newChild
smart constructor.
Instances
Eq Child Source # | |
Read Child Source # | |
Show Child Source # | |
Generic Child Source # | |
NFData Child Source # | |
Defined in Amazonka.Organizations.Types.Child | |
Hashable Child Source # | |
Defined in Amazonka.Organizations.Types.Child | |
FromJSON Child Source # | |
type Rep Child Source # | |
Defined in Amazonka.Organizations.Types.Child type Rep Child = D1 ('MetaData "Child" "Amazonka.Organizations.Types.Child" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "Child'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChildType)))) |
Create a value of Child
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Child'
, child_id
- 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.
$sel:type':Child'
, child_type
- The type of this child entity.
CreateAccountStatus
data CreateAccountStatus Source #
Contains the status about a CreateAccount or CreateGovCloudAccount request to create an AWS account or an AWS GovCloud (US) account in an organization.
See: newCreateAccountStatus
smart constructor.
CreateAccountStatus' (Maybe CreateAccountFailureReason) (Maybe CreateAccountState) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newCreateAccountStatus :: CreateAccountStatus Source #
Create a value of CreateAccountStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureReason:CreateAccountStatus'
, createAccountStatus_failureReason
- 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.
$sel:state:CreateAccountStatus'
, createAccountStatus_state
- The status of the asynchronous request to create an AWS account.
$sel:completedTimestamp:CreateAccountStatus'
, createAccountStatus_completedTimestamp
- The date and time that the account was created and the request
completed.
$sel:accountName:CreateAccountStatus'
, createAccountStatus_accountName
- The account name given to the account when it was created.
$sel:accountId:CreateAccountStatus'
, createAccountStatus_accountId
- 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.
$sel:id:CreateAccountStatus'
, createAccountStatus_id
- 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.
$sel:govCloudAccountId:CreateAccountStatus'
, createAccountStatus_govCloudAccountId
- If the account was created successfully, the unique identifier (ID) of
the new account in the AWS GovCloud (US) Region.
$sel:requestedTimestamp:CreateAccountStatus'
, createAccountStatus_requestedTimestamp
- The date and time that the request was made for the account creation.
DelegatedAdministrator
data DelegatedAdministrator Source #
Contains information about the delegated administrator.
See: newDelegatedAdministrator
smart constructor.
DelegatedAdministrator' (Maybe AccountStatus) (Maybe AccountJoinedMethod) (Maybe (Sensitive Text)) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) |
Instances
newDelegatedAdministrator :: DelegatedAdministrator Source #
Create a value of DelegatedAdministrator
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:DelegatedAdministrator'
, delegatedAdministrator_status
- The status of the delegated administrator's account in the
organization.
$sel:joinedMethod:DelegatedAdministrator'
, delegatedAdministrator_joinedMethod
- The method by which the delegated administrator's account joined the
organization.
$sel:email:DelegatedAdministrator'
, delegatedAdministrator_email
- The email address that is associated with the delegated administrator's
AWS account.
$sel:arn:DelegatedAdministrator'
, delegatedAdministrator_arn
- The Amazon Resource Name (ARN) of the delegated administrator's
account.
$sel:joinedTimestamp:DelegatedAdministrator'
, delegatedAdministrator_joinedTimestamp
- The date when the delegated administrator's account became a part of
the organization.
$sel:delegationEnabledDate:DelegatedAdministrator'
, delegatedAdministrator_delegationEnabledDate
- The date when the account was made a delegated administrator.
$sel:name:DelegatedAdministrator'
, delegatedAdministrator_name
- The friendly name of the delegated administrator's account.
$sel:id:DelegatedAdministrator'
, delegatedAdministrator_id
- The unique identifier (ID) of the delegated administrator's account.
DelegatedService
data DelegatedService Source #
Contains information about the AWS service for which the account is a delegated administrator.
See: newDelegatedService
smart constructor.
Instances
newDelegatedService :: DelegatedService Source #
Create a value of DelegatedService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:servicePrincipal:DelegatedService'
, delegatedService_servicePrincipal
- 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
.
$sel:delegationEnabledDate:DelegatedService'
, delegatedService_delegationEnabledDate
- The date that the account became a delegated administrator for this
service.
EffectivePolicy
data EffectivePolicy Source #
Contains rules to be applied to the affected accounts. The effective policy is the aggregation of any policies the account inherits, plus any policy directly attached to the account.
See: newEffectivePolicy
smart constructor.
Instances
newEffectivePolicy :: EffectivePolicy Source #
Create a value of EffectivePolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetId:EffectivePolicy'
, effectivePolicy_targetId
- The account ID of the policy target.
$sel:policyType:EffectivePolicy'
, effectivePolicy_policyType
- The policy type.
$sel:lastUpdatedTimestamp:EffectivePolicy'
, effectivePolicy_lastUpdatedTimestamp
- The time of the last update to this policy.
$sel:policyContent:EffectivePolicy'
, effectivePolicy_policyContent
- The text content of the policy.
EnabledServicePrincipal
data EnabledServicePrincipal Source #
A structure that contains details of a service principal that represents an AWS service that is enabled to integrate with AWS Organizations.
See: newEnabledServicePrincipal
smart constructor.
Instances
newEnabledServicePrincipal :: EnabledServicePrincipal Source #
Create a value of EnabledServicePrincipal
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:servicePrincipal:EnabledServicePrincipal'
, enabledServicePrincipal_servicePrincipal
- The name of the service principal. This is typically in the form of a
URL, such as: servicename.amazonaws.com
.
$sel:dateEnabled:EnabledServicePrincipal'
, enabledServicePrincipal_dateEnabled
- The date that the service principal was enabled for integration with AWS
Organizations.
Handshake
Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a management account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.
Note: Handshakes that are CANCELED
, ACCEPTED
, or DECLINED
show
up in lists for only 30 days after entering that state After that they
are deleted.
See: newHandshake
smart constructor.
Handshake' (Maybe HandshakeState) (Maybe Text) (Maybe ActionType) (Maybe [HandshakeResource]) (Maybe Text) (Maybe POSIX) (Maybe [HandshakeParty]) (Maybe POSIX) |
Instances
newHandshake :: Handshake Source #
Create a value of Handshake
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:state:Handshake'
, handshake_state
- 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).
$sel:arn:Handshake'
, handshake_arn
- 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.
$sel:action:Handshake'
, handshake_action
- 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.
$sel:resources:Handshake'
, handshake_resources
- Additional information that is needed to process the handshake.
$sel:id:Handshake'
, handshake_id
- 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.
$sel:expirationTimestamp:Handshake'
, handshake_expirationTimestamp
- 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.
$sel:parties:Handshake'
, handshake_parties
- Information about the two accounts that are participating in the
handshake.
$sel:requestedTimestamp:Handshake'
, handshake_requestedTimestamp
- The date and time that the handshake request was made.
HandshakeFilter
data HandshakeFilter Source #
Specifies the criteria that are used to select the handshakes for the operation.
See: newHandshakeFilter
smart constructor.
Instances
newHandshakeFilter :: HandshakeFilter Source #
Create a value of HandshakeFilter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parentHandshakeId:HandshakeFilter'
, handshakeFilter_parentHandshakeId
- 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.
$sel:actionType:HandshakeFilter'
, handshakeFilter_actionType
- Specifies the type of handshake action.
If you specify ActionType
, you cannot also specify
ParentHandshakeId
.
HandshakeParty
data HandshakeParty Source #
Identifies a participant in a handshake.
See: newHandshakeParty
smart constructor.
Instances
Create a value of HandshakeParty
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:HandshakeParty'
, handshakeParty_id
- 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.
$sel:type':HandshakeParty'
, handshakeParty_type
- The type of party.
HandshakeResource
data HandshakeResource Source #
Contains additional data that is needed to process a handshake.
See: newHandshakeResource
smart constructor.
HandshakeResource' (Maybe (Sensitive Text)) (Maybe [HandshakeResource]) (Maybe HandshakeResourceType) |
Instances
newHandshakeResource :: HandshakeResource Source #
Create a value of HandshakeResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:HandshakeResource'
, handshakeResource_value
- 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.
$sel:resources:HandshakeResource'
, handshakeResource_resources
- When needed, contains an additional array of HandshakeResource
objects.
$sel:type':HandshakeResource'
, handshakeResource_type
- 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
data Organization Source #
Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .
See: newOrganization
smart constructor.
Organization' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe [PolicyTypeSummary]) (Maybe Text) (Maybe OrganizationFeatureSet) |
Instances
newOrganization :: Organization Source #
Create a value of Organization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Organization'
, organization_arn
- 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.
$sel:masterAccountId:Organization'
, organization_masterAccountId
- The unique identifier (ID) of the management account of an organization.
The regex pattern for an account ID string requires exactly 12 digits.
$sel:masterAccountArn:Organization'
, organization_masterAccountArn
- 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.
$sel:masterAccountEmail:Organization'
, organization_masterAccountEmail
- The email address that is associated with the AWS account that is
designated as the management account for the organization.
$sel:availablePolicyTypes:Organization'
, organization_availablePolicyTypes
- 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.
$sel:id:Organization'
, organization_id
- 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.
$sel:featureSet:Organization'
, organization_featureSet
- 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
data OrganizationalUnit Source #
Contains details about an organizational unit (OU). An OU is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.
See: newOrganizationalUnit
smart constructor.
Instances
newOrganizationalUnit :: OrganizationalUnit Source #
Create a value of OrganizationalUnit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:OrganizationalUnit'
, organizationalUnit_arn
- 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.
$sel:name:OrganizationalUnit'
, organizationalUnit_name
- 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.
$sel:id:OrganizationalUnit'
, organizationalUnit_id
- 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
Contains information about either a root or an organizational unit (OU) that can contain OUs or accounts in an organization.
See: newParent
smart constructor.
Parent' (Maybe Text) (Maybe ParentType) |
Instances
Eq Parent Source # | |
Read Parent Source # | |
Show Parent Source # | |
Generic Parent Source # | |
NFData Parent Source # | |
Defined in Amazonka.Organizations.Types.Parent | |
Hashable Parent Source # | |
Defined in Amazonka.Organizations.Types.Parent | |
FromJSON Parent Source # | |
type Rep Parent Source # | |
Defined in Amazonka.Organizations.Types.Parent type Rep Parent = D1 ('MetaData "Parent" "Amazonka.Organizations.Types.Parent" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "Parent'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParentType)))) |
Create a value of Parent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Parent'
, parent_id
- 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.
$sel:type':Parent'
, parent_type
- The type of the parent entity.
Policy
Contains rules to be applied to the affected accounts. Policies can be attached directly to accounts, or to roots and OUs to affect all accounts in those hierarchies.
See: newPolicy
smart constructor.
Instances
Eq Policy Source # | |
Read Policy Source # | |
Show Policy Source # | |
Generic Policy Source # | |
NFData Policy Source # | |
Defined in Amazonka.Organizations.Types.Policy | |
Hashable Policy Source # | |
Defined in Amazonka.Organizations.Types.Policy | |
FromJSON Policy Source # | |
type Rep Policy Source # | |
Defined in Amazonka.Organizations.Types.Policy type Rep Policy = D1 ('MetaData "Policy" "Amazonka.Organizations.Types.Policy" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "Policy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policySummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PolicySummary)))) |
Create a value of Policy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:content:Policy'
, policy_content
- The text content of the policy.
$sel:policySummary:Policy'
, policy_policySummary
- A structure that contains additional details about the policy.
PolicySummary
data PolicySummary Source #
Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.
See: newPolicySummary
smart constructor.
Instances
newPolicySummary :: PolicySummary Source #
Create a value of PolicySummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:PolicySummary'
, policySummary_arn
- 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.
$sel:name:PolicySummary'
, policySummary_name
- 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.
$sel:id:PolicySummary'
, policySummary_id
- 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 (_).
$sel:awsManaged:PolicySummary'
, policySummary_awsManaged
- 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.
$sel:type':PolicySummary'
, policySummary_type
- The type of policy.
$sel:description:PolicySummary'
, policySummary_description
- The description of the policy.
PolicyTargetSummary
data PolicyTargetSummary Source #
Contains information about a root, OU, or account that a policy is attached to.
See: newPolicyTargetSummary
smart constructor.
PolicyTargetSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TargetType) |
Instances
newPolicyTargetSummary :: PolicyTargetSummary Source #
Create a value of PolicyTargetSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:targetId:PolicyTargetSummary'
, policyTargetSummary_targetId
- 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.
$sel:arn:PolicyTargetSummary'
, policyTargetSummary_arn
- 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.
$sel:name:PolicyTargetSummary'
, policyTargetSummary_name
- 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.
$sel:type':PolicyTargetSummary'
, policyTargetSummary_type
- The type of the policy target.
PolicyTypeSummary
data PolicyTypeSummary Source #
Contains information about a policy type and its status in the associated root.
See: newPolicyTypeSummary
smart constructor.
Instances
newPolicyTypeSummary :: PolicyTypeSummary Source #
Create a value of PolicyTypeSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:PolicyTypeSummary'
, policyTypeSummary_status
- 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.
$sel:type':PolicyTypeSummary'
, policyTypeSummary_type
- The name of the policy type.
Root
Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. The root contains every AWS account in the organization.
See: newRoot
smart constructor.
Instances
Eq Root Source # | |
Read Root Source # | |
Show Root Source # | |
Generic Root Source # | |
NFData Root Source # | |
Defined in Amazonka.Organizations.Types.Root | |
Hashable Root Source # | |
Defined in Amazonka.Organizations.Types.Root | |
FromJSON Root Source # | |
type Rep Root Source # | |
Defined in Amazonka.Organizations.Types.Root type Rep Root = D1 ('MetaData "Root" "Amazonka.Organizations.Types.Root" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "Root'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policyTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PolicyTypeSummary]))))) |
Create a value of Root
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Root'
, root_arn
- 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.
$sel:name:Root'
, root_name
- 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.
$sel:id:Root'
, root_id
- 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.
$sel:policyTypes:Root'
, root_policyTypes
- 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
A custom key-value pair associated with a resource within your organization.
You can attach tags to any of the following organization resources.
- AWS account
- Organizational unit (OU)
- Organization root
- Policy
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Organizations.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.Organizations.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.Organizations.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.Organizations.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Organizations.Types.Tag" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- The key identifier, or name, of the tag.
$sel:value:Tag'
, tag_value
- 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.