create_domain_for_organization
¶
create_domain_for_organization(
name: str,
identity_providers: IdentityProviderList,
domain_access_role_arn: IamRoleArn,
*,
config_overrides: Optional[CloudWatchOmniClientConfig] = None,
identity_provider_configuration: Optional[IdentityProviderConfiguration] = None,
tags: Optional[TagMap] = None,
client_token: Optional[ClientToken] = None,
) -> CreateDomainForOrganizationOutput
Creates an organization-scoped domain for the caller's AWS Organization. Only the organization's management account can call this operation.
Parameters:
-
name(str) –A name that identifies the organization domain. Must be 3-63 characters: lowercase letters, numbers, and hyphens. It must begin and end with a letter or number and cannot contain consecutive hyphens.
-
identity_providers(IdentityProviderList) –The identity providers to configure for the domain.
-
identity_provider_configuration(Optional[IdentityProviderConfiguration], default:None) –Identity provider configuration for the domain.
-
domain_access_role_arn(IamRoleArn) –The ARN of an IAM role in the management account used for domain access. You must create this role, and its trust policy must allow the service principal to assume it.
-
tags(Optional[TagMap], default:None) –The tags to associate with the domain.
-
client_token(Optional[ClientToken], default:None) –Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.
Raises:
-
AccessDeniedException–The caller is not authorized to perform this action.
-
ConflictException–The operation could not be completed because of a conflict with the current state of the resource.
-
InternalServerException–An unexpected error occurred while processing the request.
-
ThrottlingException–The request was throttled due to exceeding the allowed request rate.
-
ValidationException–A parameter is specified incorrectly.
-
UnknownServiceError–The service returned an error code this client does not model.
Examples:
Create an organization domain The following example creates an organization-scoped domain from the organization's management account, configures it with an Identity Center instance, and supplies an IAM role in the management account for domain access. Payloads are shown as JSON; on the wire they are CBOR-encoded.
>>> client.create_domain_for_organization(name='prod-observability-org', identity_providers=['IDC'], identity_provider_configuration={'identityCenterConfiguration': {'identityCenterInstanceArn': 'arn:aws:sso:::instance/ssoins-1234567890abcdef'}}, domain_access_role_arn='arn:aws:iam::123456789012:role/CloudWatchOrganizationDomainAccessRole', tags={'Team': 'observability'}, client_token='3f2a9c1e-7b04-4d8a-9e15-6c2b8d0f4a73')
Source code in docs_src/capo_cloudwatchomni/_services/cloud_watch_omni.py
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 | |