Skip to content

Type definitions#

Index > Organizations > Type definitions

Auto-generated documentation for Organizations type annotations stubs module mypy-boto3-organizations.

AcceptHandshakeRequestRequestTypeDef#

# AcceptHandshakeRequestRequestTypeDef definition

class AcceptHandshakeRequestRequestTypeDef(TypedDict):
    HandshakeId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AccountTypeDef#

# AccountTypeDef definition

class AccountTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Email: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[AccountStatusType],  # (1)
    JoinedMethod: NotRequired[AccountJoinedMethodType],  # (2)
    JoinedTimestamp: NotRequired[datetime],
  1. See AccountStatusType
  2. See AccountJoinedMethodType

AttachPolicyRequestRequestTypeDef#

# AttachPolicyRequestRequestTypeDef definition

class AttachPolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,
    TargetId: str,

CancelHandshakeRequestRequestTypeDef#

# CancelHandshakeRequestRequestTypeDef definition

class CancelHandshakeRequestRequestTypeDef(TypedDict):
    HandshakeId: str,

ChildTypeDef#

# ChildTypeDef definition

class ChildTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[ChildTypeType],  # (1)
  1. See ChildTypeType

CloseAccountRequestRequestTypeDef#

# CloseAccountRequestRequestTypeDef definition

class CloseAccountRequestRequestTypeDef(TypedDict):
    AccountId: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CreateAccountStatusTypeDef#

# CreateAccountStatusTypeDef definition

class CreateAccountStatusTypeDef(TypedDict):
    Id: NotRequired[str],
    AccountName: NotRequired[str],
    State: NotRequired[CreateAccountStateType],  # (1)
    RequestedTimestamp: NotRequired[datetime],
    CompletedTimestamp: NotRequired[datetime],
    AccountId: NotRequired[str],
    GovCloudAccountId: NotRequired[str],
    FailureReason: NotRequired[CreateAccountFailureReasonType],  # (2)
  1. See CreateAccountStateType
  2. See CreateAccountFailureReasonType

CreateOrganizationRequestRequestTypeDef#

# CreateOrganizationRequestRequestTypeDef definition

class CreateOrganizationRequestRequestTypeDef(TypedDict):
    FeatureSet: NotRequired[OrganizationFeatureSetType],  # (1)
  1. See OrganizationFeatureSetType

OrganizationalUnitTypeDef#

# OrganizationalUnitTypeDef definition

class OrganizationalUnitTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],

DeclineHandshakeRequestRequestTypeDef#

# DeclineHandshakeRequestRequestTypeDef definition

class DeclineHandshakeRequestRequestTypeDef(TypedDict):
    HandshakeId: str,

DelegatedAdministratorTypeDef#

# DelegatedAdministratorTypeDef definition

class DelegatedAdministratorTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Email: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[AccountStatusType],  # (1)
    JoinedMethod: NotRequired[AccountJoinedMethodType],  # (2)
    JoinedTimestamp: NotRequired[datetime],
    DelegationEnabledDate: NotRequired[datetime],
  1. See AccountStatusType
  2. See AccountJoinedMethodType

DelegatedServiceTypeDef#

# DelegatedServiceTypeDef definition

class DelegatedServiceTypeDef(TypedDict):
    ServicePrincipal: NotRequired[str],
    DelegationEnabledDate: NotRequired[datetime],

DeleteOrganizationalUnitRequestRequestTypeDef#

# DeleteOrganizationalUnitRequestRequestTypeDef definition

class DeleteOrganizationalUnitRequestRequestTypeDef(TypedDict):
    OrganizationalUnitId: str,

DeletePolicyRequestRequestTypeDef#

# DeletePolicyRequestRequestTypeDef definition

class DeletePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

DeregisterDelegatedAdministratorRequestRequestTypeDef#

# DeregisterDelegatedAdministratorRequestRequestTypeDef definition

class DeregisterDelegatedAdministratorRequestRequestTypeDef(TypedDict):
    AccountId: str,
    ServicePrincipal: str,

DescribeAccountRequestRequestTypeDef#

# DescribeAccountRequestRequestTypeDef definition

class DescribeAccountRequestRequestTypeDef(TypedDict):
    AccountId: str,

DescribeCreateAccountStatusRequestRequestTypeDef#

# DescribeCreateAccountStatusRequestRequestTypeDef definition

class DescribeCreateAccountStatusRequestRequestTypeDef(TypedDict):
    CreateAccountRequestId: str,

DescribeEffectivePolicyRequestRequestTypeDef#

# DescribeEffectivePolicyRequestRequestTypeDef definition

class DescribeEffectivePolicyRequestRequestTypeDef(TypedDict):
    PolicyType: EffectivePolicyTypeType,  # (1)
    TargetId: NotRequired[str],
  1. See EffectivePolicyTypeType

EffectivePolicyTypeDef#

# EffectivePolicyTypeDef definition

class EffectivePolicyTypeDef(TypedDict):
    PolicyContent: NotRequired[str],
    LastUpdatedTimestamp: NotRequired[datetime],
    TargetId: NotRequired[str],
    PolicyType: NotRequired[EffectivePolicyTypeType],  # (1)
  1. See EffectivePolicyTypeType

DescribeHandshakeRequestRequestTypeDef#

# DescribeHandshakeRequestRequestTypeDef definition

class DescribeHandshakeRequestRequestTypeDef(TypedDict):
    HandshakeId: str,

DescribeOrganizationalUnitRequestRequestTypeDef#

# DescribeOrganizationalUnitRequestRequestTypeDef definition

class DescribeOrganizationalUnitRequestRequestTypeDef(TypedDict):
    OrganizationalUnitId: str,

DescribePolicyRequestRequestTypeDef#

# DescribePolicyRequestRequestTypeDef definition

class DescribePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,

DetachPolicyRequestRequestTypeDef#

# DetachPolicyRequestRequestTypeDef definition

class DetachPolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,
    TargetId: str,

DisableAWSServiceAccessRequestRequestTypeDef#

# DisableAWSServiceAccessRequestRequestTypeDef definition

class DisableAWSServiceAccessRequestRequestTypeDef(TypedDict):
    ServicePrincipal: str,

DisablePolicyTypeRequestRequestTypeDef#

# DisablePolicyTypeRequestRequestTypeDef definition

class DisablePolicyTypeRequestRequestTypeDef(TypedDict):
    RootId: str,
    PolicyType: PolicyTypeType,  # (1)
  1. See PolicyTypeType

EnableAWSServiceAccessRequestRequestTypeDef#

# EnableAWSServiceAccessRequestRequestTypeDef definition

class EnableAWSServiceAccessRequestRequestTypeDef(TypedDict):
    ServicePrincipal: str,

EnablePolicyTypeRequestRequestTypeDef#

# EnablePolicyTypeRequestRequestTypeDef definition

class EnablePolicyTypeRequestRequestTypeDef(TypedDict):
    RootId: str,
    PolicyType: PolicyTypeType,  # (1)
  1. See PolicyTypeType

EnabledServicePrincipalTypeDef#

# EnabledServicePrincipalTypeDef definition

class EnabledServicePrincipalTypeDef(TypedDict):
    ServicePrincipal: NotRequired[str],
    DateEnabled: NotRequired[datetime],

HandshakeFilterTypeDef#

# HandshakeFilterTypeDef definition

class HandshakeFilterTypeDef(TypedDict):
    ActionType: NotRequired[ActionTypeType],  # (1)
    ParentHandshakeId: NotRequired[str],
  1. See ActionTypeType

HandshakePartyTypeDef#

# HandshakePartyTypeDef definition

class HandshakePartyTypeDef(TypedDict):
    Id: str,
    Type: HandshakePartyTypeType,  # (1)
  1. See HandshakePartyTypeType

HandshakeResourceTypeDef#

# HandshakeResourceTypeDef definition

class HandshakeResourceTypeDef(TypedDict):
    Value: NotRequired[str],
    Type: NotRequired[HandshakeResourceTypeType],  # (1)
    Resources: NotRequired[List[Dict[str, Any]]],
  1. See HandshakeResourceTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAWSServiceAccessForOrganizationRequestRequestTypeDef#

# ListAWSServiceAccessForOrganizationRequestRequestTypeDef definition

class ListAWSServiceAccessForOrganizationRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListAccountsForParentRequestRequestTypeDef#

# ListAccountsForParentRequestRequestTypeDef definition

class ListAccountsForParentRequestRequestTypeDef(TypedDict):
    ParentId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListAccountsRequestRequestTypeDef#

# ListAccountsRequestRequestTypeDef definition

class ListAccountsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListChildrenRequestRequestTypeDef#

# ListChildrenRequestRequestTypeDef definition

class ListChildrenRequestRequestTypeDef(TypedDict):
    ParentId: str,
    ChildType: ChildTypeType,  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ChildTypeType

ListCreateAccountStatusRequestRequestTypeDef#

# ListCreateAccountStatusRequestRequestTypeDef definition

class ListCreateAccountStatusRequestRequestTypeDef(TypedDict):
    States: NotRequired[Sequence[CreateAccountStateType]],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See CreateAccountStateType

ListDelegatedAdministratorsRequestRequestTypeDef#

# ListDelegatedAdministratorsRequestRequestTypeDef definition

class ListDelegatedAdministratorsRequestRequestTypeDef(TypedDict):
    ServicePrincipal: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListDelegatedServicesForAccountRequestRequestTypeDef#

# ListDelegatedServicesForAccountRequestRequestTypeDef definition

class ListDelegatedServicesForAccountRequestRequestTypeDef(TypedDict):
    AccountId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListOrganizationalUnitsForParentRequestRequestTypeDef#

# ListOrganizationalUnitsForParentRequestRequestTypeDef definition

class ListOrganizationalUnitsForParentRequestRequestTypeDef(TypedDict):
    ParentId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListParentsRequestRequestTypeDef#

# ListParentsRequestRequestTypeDef definition

class ListParentsRequestRequestTypeDef(TypedDict):
    ChildId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ParentTypeDef#

# ParentTypeDef definition

class ParentTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[ParentTypeType],  # (1)
  1. See ParentTypeType

ListPoliciesForTargetRequestRequestTypeDef#

# ListPoliciesForTargetRequestRequestTypeDef definition

class ListPoliciesForTargetRequestRequestTypeDef(TypedDict):
    TargetId: str,
    Filter: PolicyTypeType,  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See PolicyTypeType

PolicySummaryTypeDef#

# PolicySummaryTypeDef definition

class PolicySummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    Type: NotRequired[PolicyTypeType],  # (1)
    AwsManaged: NotRequired[bool],
  1. See PolicyTypeType

ListPoliciesRequestRequestTypeDef#

# ListPoliciesRequestRequestTypeDef definition

class ListPoliciesRequestRequestTypeDef(TypedDict):
    Filter: PolicyTypeType,  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See PolicyTypeType

ListRootsRequestRequestTypeDef#

# ListRootsRequestRequestTypeDef definition

class ListRootsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    NextToken: NotRequired[str],

ListTargetsForPolicyRequestRequestTypeDef#

# ListTargetsForPolicyRequestRequestTypeDef definition

class ListTargetsForPolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

PolicyTargetSummaryTypeDef#

# PolicyTargetSummaryTypeDef definition

class PolicyTargetSummaryTypeDef(TypedDict):
    TargetId: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Type: NotRequired[TargetTypeType],  # (1)
  1. See TargetTypeType

MoveAccountRequestRequestTypeDef#

# MoveAccountRequestRequestTypeDef definition

class MoveAccountRequestRequestTypeDef(TypedDict):
    AccountId: str,
    SourceParentId: str,
    DestinationParentId: str,

PolicyTypeSummaryTypeDef#

# PolicyTypeSummaryTypeDef definition

class PolicyTypeSummaryTypeDef(TypedDict):
    Type: NotRequired[PolicyTypeType],  # (1)
    Status: NotRequired[PolicyTypeStatusType],  # (2)
  1. See PolicyTypeType
  2. See PolicyTypeStatusType

RegisterDelegatedAdministratorRequestRequestTypeDef#

# RegisterDelegatedAdministratorRequestRequestTypeDef definition

class RegisterDelegatedAdministratorRequestRequestTypeDef(TypedDict):
    AccountId: str,
    ServicePrincipal: str,

RemoveAccountFromOrganizationRequestRequestTypeDef#

# RemoveAccountFromOrganizationRequestRequestTypeDef definition

class RemoveAccountFromOrganizationRequestRequestTypeDef(TypedDict):
    AccountId: str,

ResourcePolicySummaryTypeDef#

# ResourcePolicySummaryTypeDef definition

class ResourcePolicySummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    TagKeys: Sequence[str],

UpdateOrganizationalUnitRequestRequestTypeDef#

# UpdateOrganizationalUnitRequestRequestTypeDef definition

class UpdateOrganizationalUnitRequestRequestTypeDef(TypedDict):
    OrganizationalUnitId: str,
    Name: NotRequired[str],

UpdatePolicyRequestRequestTypeDef#

# UpdatePolicyRequestRequestTypeDef definition

class UpdatePolicyRequestRequestTypeDef(TypedDict):
    PolicyId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    Content: NotRequired[str],

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAccountResponseTypeDef#

# DescribeAccountResponseTypeDef definition

class DescribeAccountResponseTypeDef(TypedDict):
    Account: AccountTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountTypeDef
  2. See ResponseMetadataTypeDef

ListAccountsForParentResponseTypeDef#

# ListAccountsForParentResponseTypeDef definition

class ListAccountsForParentResponseTypeDef(TypedDict):
    Accounts: List[AccountTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountTypeDef
  2. See ResponseMetadataTypeDef

ListAccountsResponseTypeDef#

# ListAccountsResponseTypeDef definition

class ListAccountsResponseTypeDef(TypedDict):
    Accounts: List[AccountTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountTypeDef
  2. See ResponseMetadataTypeDef

ListChildrenResponseTypeDef#

# ListChildrenResponseTypeDef definition

class ListChildrenResponseTypeDef(TypedDict):
    Children: List[ChildTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ChildTypeDef
  2. See