Skip to content

Type definitions#

Index > RAM > Type definitions

Auto-generated documentation for RAM type annotations stubs module mypy-boto3-ram.

AcceptResourceShareInvitationRequestRequestTypeDef#

# AcceptResourceShareInvitationRequestRequestTypeDef definition

class AcceptResourceShareInvitationRequestRequestTypeDef(TypedDict):
    resourceShareInvitationArn: str,
    clientToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

AssociateResourceSharePermissionRequestRequestTypeDef#

# AssociateResourceSharePermissionRequestRequestTypeDef definition

class AssociateResourceSharePermissionRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,
    permissionArn: str,
    replace: NotRequired[bool],
    clientToken: NotRequired[str],
    permissionVersion: NotRequired[int],

AssociateResourceShareRequestRequestTypeDef#

# AssociateResourceShareRequestRequestTypeDef definition

class AssociateResourceShareRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,
    resourceArns: NotRequired[Sequence[str]],
    principals: NotRequired[Sequence[str]],
    clientToken: NotRequired[str],
    sources: NotRequired[Sequence[str]],

ResourceShareAssociationTypeDef#

# ResourceShareAssociationTypeDef definition

class ResourceShareAssociationTypeDef(TypedDict):
    resourceShareArn: NotRequired[str],
    resourceShareName: NotRequired[str],
    associatedEntity: NotRequired[str],
    associationType: NotRequired[ResourceShareAssociationTypeType],  # (1)
    status: NotRequired[ResourceShareAssociationStatusType],  # (2)
    statusMessage: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdatedTime: NotRequired[datetime],
    external: NotRequired[bool],
  1. See ResourceShareAssociationTypeType
  2. See ResourceShareAssociationStatusType

AssociatedPermissionTypeDef#

# AssociatedPermissionTypeDef definition

class AssociatedPermissionTypeDef(TypedDict):
    arn: NotRequired[str],
    permissionVersion: NotRequired[str],
    defaultVersion: NotRequired[bool],
    resourceType: NotRequired[str],
    status: NotRequired[str],
    featureSet: NotRequired[PermissionFeatureSetType],  # (1)
    lastUpdatedTime: NotRequired[datetime],
    resourceShareArn: NotRequired[str],
  1. See PermissionFeatureSetType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: NotRequired[str],
    value: NotRequired[str],

CreatePermissionVersionRequestRequestTypeDef#

# CreatePermissionVersionRequestRequestTypeDef definition

class CreatePermissionVersionRequestRequestTypeDef(TypedDict):
    permissionArn: str,
    policyTemplate: str,
    clientToken: NotRequired[str],

DeletePermissionRequestRequestTypeDef#

# DeletePermissionRequestRequestTypeDef definition

class DeletePermissionRequestRequestTypeDef(TypedDict):
    permissionArn: str,
    clientToken: NotRequired[str],

DeletePermissionVersionRequestRequestTypeDef#

# DeletePermissionVersionRequestRequestTypeDef definition

class DeletePermissionVersionRequestRequestTypeDef(TypedDict):
    permissionArn: str,
    permissionVersion: int,
    clientToken: NotRequired[str],

DeleteResourceShareRequestRequestTypeDef#

# DeleteResourceShareRequestRequestTypeDef definition

class DeleteResourceShareRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,
    clientToken: NotRequired[str],

DisassociateResourceSharePermissionRequestRequestTypeDef#

# DisassociateResourceSharePermissionRequestRequestTypeDef definition

class DisassociateResourceSharePermissionRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,
    permissionArn: str,
    clientToken: NotRequired[str],

DisassociateResourceShareRequestRequestTypeDef#

# DisassociateResourceShareRequestRequestTypeDef definition

class DisassociateResourceShareRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,
    resourceArns: NotRequired[Sequence[str]],
    principals: NotRequired[Sequence[str]],
    clientToken: NotRequired[str],
    sources: NotRequired[Sequence[str]],

GetPermissionRequestRequestTypeDef#

# GetPermissionRequestRequestTypeDef definition

class GetPermissionRequestRequestTypeDef(TypedDict):
    permissionArn: str,
    permissionVersion: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

GetResourcePoliciesRequestRequestTypeDef#

# GetResourcePoliciesRequestRequestTypeDef definition

class GetResourcePoliciesRequestRequestTypeDef(TypedDict):
    resourceArns: Sequence[str],
    principal: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetResourceShareAssociationsRequestRequestTypeDef#

# GetResourceShareAssociationsRequestRequestTypeDef definition

class GetResourceShareAssociationsRequestRequestTypeDef(TypedDict):
    associationType: ResourceShareAssociationTypeType,  # (1)
    resourceShareArns: NotRequired[Sequence[str]],
    resourceArn: NotRequired[str],
    principal: NotRequired[str],
    associationStatus: NotRequired[ResourceShareAssociationStatusType],  # (2)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ResourceShareAssociationTypeType
  2. See ResourceShareAssociationStatusType

GetResourceShareInvitationsRequestRequestTypeDef#

# GetResourceShareInvitationsRequestRequestTypeDef definition

class GetResourceShareInvitationsRequestRequestTypeDef(TypedDict):
    resourceShareInvitationArns: NotRequired[Sequence[str]],
    resourceShareArns: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

TagFilterTypeDef#

# TagFilterTypeDef definition

class TagFilterTypeDef(TypedDict):
    tagKey: NotRequired[str],
    tagValues: NotRequired[Sequence[str]],

ListPendingInvitationResourcesRequestRequestTypeDef#

# ListPendingInvitationResourcesRequestRequestTypeDef definition

class ListPendingInvitationResourcesRequestRequestTypeDef(TypedDict):
    resourceShareInvitationArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    resourceRegionScope: NotRequired[ResourceRegionScopeFilterType],  # (1)
  1. See ResourceRegionScopeFilterType

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    arn: NotRequired[str],
    type: NotRequired[str],
    resourceShareArn: NotRequired[str],
    resourceGroupArn: NotRequired[str],
    status: NotRequired[ResourceStatusType],  # (1)
    statusMessage: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdatedTime: NotRequired[datetime],
    resourceRegionScope: NotRequired[ResourceRegionScopeType],  # (2)
  1. See ResourceStatusType
  2. See ResourceRegionScopeType

ListPermissionAssociationsRequestRequestTypeDef#

# ListPermissionAssociationsRequestRequestTypeDef definition

class ListPermissionAssociationsRequestRequestTypeDef(TypedDict):
    permissionArn: NotRequired[str],
    permissionVersion: NotRequired[int],
    associationStatus: NotRequired[ResourceShareAssociationStatusType],  # (1)
    resourceType: NotRequired[str],
    featureSet: NotRequired[PermissionFeatureSetType],  # (2)
    defaultVersion: NotRequired[bool],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ResourceShareAssociationStatusType
  2. See PermissionFeatureSetType

ListPermissionVersionsRequestRequestTypeDef#

# ListPermissionVersionsRequestRequestTypeDef definition

class ListPermissionVersionsRequestRequestTypeDef(TypedDict):
    permissionArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPermissionsRequestRequestTypeDef#

# ListPermissionsRequestRequestTypeDef definition

class ListPermissionsRequestRequestTypeDef(TypedDict):
    resourceType: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    permissionType: NotRequired[PermissionTypeFilterType],  # (1)
  1. See PermissionTypeFilterType

ListPrincipalsRequestRequestTypeDef#

# ListPrincipalsRequestRequestTypeDef definition

class ListPrincipalsRequestRequestTypeDef(TypedDict):
    resourceOwner: ResourceOwnerType,  # (1)
    resourceArn: NotRequired[str],
    principals: NotRequired[Sequence[str]],
    resourceType: NotRequired[str],
    resourceShareArns: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ResourceOwnerType

PrincipalTypeDef#

# PrincipalTypeDef definition

class PrincipalTypeDef(TypedDict):
    id: NotRequired[str],
    resourceShareArn: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdatedTime: NotRequired[datetime],
    external: NotRequired[bool],

ListReplacePermissionAssociationsWorkRequestRequestTypeDef#

# ListReplacePermissionAssociationsWorkRequestRequestTypeDef definition

class ListReplacePermissionAssociationsWorkRequestRequestTypeDef(TypedDict):
    workIds: NotRequired[Sequence[str]],
    status: NotRequired[ReplacePermissionAssociationsWorkStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ReplacePermissionAssociationsWorkStatusType

ReplacePermissionAssociationsWorkTypeDef#

# ReplacePermissionAssociationsWorkTypeDef definition

class ReplacePermissionAssociationsWorkTypeDef(TypedDict):
    id: NotRequired[str],
    fromPermissionArn: NotRequired[str],
    fromPermissionVersion: NotRequired[str],
    toPermissionArn: NotRequired[str],
    toPermissionVersion: NotRequired[str],
    status: NotRequired[ReplacePermissionAssociationsWorkStatusType],  # (1)
    statusMessage: NotRequired[str],
    creationTime: NotRequired[datetime],
    lastUpdatedTime: NotRequired[datetime],
  1. See ReplacePermissionAssociationsWorkStatusType

ListResourceSharePermissionsRequestRequestTypeDef#

# ListResourceSharePermissionsRequestRequestTypeDef definition

class ListResourceSharePermissionsRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListResourceTypesRequestRequestTypeDef#

# ListResourceTypesRequestRequestTypeDef definition

class ListResourceTypesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    resourceRegionScope: NotRequired[ResourceRegionScopeFilterType],  # (1)
  1. See ResourceRegionScopeFilterType

ServiceNameAndResourceTypeTypeDef#

# ServiceNameAndResourceTypeTypeDef definition

class ServiceNameAndResourceTypeTypeDef(TypedDict):
    resourceType: NotRequired[str],
    serviceName: NotRequired[str],
    resourceRegionScope: NotRequired[ResourceRegionScopeType],  # (1)
  1. See ResourceRegionScopeType

ListResourcesRequestRequestTypeDef#

# ListResourcesRequestRequestTypeDef definition

class ListResourcesRequestRequestTypeDef(TypedDict):
    resourceOwner: ResourceOwnerType,  # (1)
    principal: NotRequired[str],
    resourceType: NotRequired[str],
    resourceArns: NotRequired[Sequence[str]],
    resourceShareArns: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    resourceRegionScope: NotRequired[ResourceRegionScopeFilterType],  # (2)
  1. See ResourceOwnerType
  2. See ResourceRegionScopeFilterType

PromotePermissionCreatedFromPolicyRequestRequestTypeDef#

# PromotePermissionCreatedFromPolicyRequestRequestTypeDef definition

class PromotePermissionCreatedFromPolicyRequestRequestTypeDef(TypedDict):
    permissionArn: str,
    name: str,
    clientToken: NotRequired[str],

PromoteResourceShareCreatedFromPolicyRequestRequestTypeDef#

# PromoteResourceShareCreatedFromPolicyRequestRequestTypeDef definition

class PromoteResourceShareCreatedFromPolicyRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,

RejectResourceShareInvitationRequestRequestTypeDef#

# RejectResourceShareInvitationRequestRequestTypeDef definition

class RejectResourceShareInvitationRequestRequestTypeDef(TypedDict):
    resourceShareInvitationArn: str,
    clientToken: NotRequired[str],

ReplacePermissionAssociationsRequestRequestTypeDef#

# ReplacePermissionAssociationsRequestRequestTypeDef definition

class ReplacePermissionAssociationsRequestRequestTypeDef(TypedDict):
    fromPermissionArn: str,
    toPermissionArn: str,
    fromPermissionVersion: NotRequired[int],
    clientToken: NotRequired[str],

SetDefaultPermissionVersionRequestRequestTypeDef#

# SetDefaultPermissionVersionRequestRequestTypeDef definition

class SetDefaultPermissionVersionRequestRequestTypeDef(TypedDict):
    permissionArn: str,
    permissionVersion: int,
    clientToken: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    tagKeys: Sequence[str],
    resourceShareArn: NotRequired[str],
    resourceArn: NotRequired[str],

UpdateResourceShareRequestRequestTypeDef#

# UpdateResourceShareRequestRequestTypeDef definition

class UpdateResourceShareRequestRequestTypeDef(TypedDict):
    resourceShareArn: str,
    name: NotRequired[str],
    allowExternalPrincipals: NotRequired[bool],
    clientToken: NotRequired[str],

AssociateResourceSharePermissionResponseTypeDef#

# AssociateResourceSharePermissionResponseTypeDef definition

class AssociateResourceSharePermissionResponseTypeDef(TypedDict):
    returnValue: bool,
    clientToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeletePermissionResponseTypeDef#

# DeletePermissionResponseTypeDef definition

class DeletePermissionResponseTypeDef(TypedDict):
    returnValue: bool,
    clientToken: str,
    permissionStatus: PermissionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionStatusType
  2. See ResponseMetadataTypeDef

DeletePermissionVersionResponseTypeDef#

# DeletePermissionVersionResponseTypeDef definition

class DeletePermissionVersionResponseTypeDef(TypedDict):
    returnValue: bool,
    clientToken: str,
    permissionStatus: PermissionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionStatusType
  2. See ResponseMetadataTypeDef

DeleteResourceShareResponseTypeDef#

# DeleteResourceShareResponseTypeDef definition

class DeleteResourceShareResponseTypeDef(TypedDict):
    returnValue: bool,
    clientToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisassociateResourceSharePermissionResponseTypeDef#

# DisassociateResourceSharePermissionResponseTypeDef definition

class DisassociateResourceSharePermissionResponseTypeDef(TypedDict):
    returnValue: bool,
    clientToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EnableSharingWithAwsOrganizationResponseTypeDef#

# EnableSharingWithAwsOrganizationResponseTypeDef definition

class EnableSharingWithAwsOrganizationResponseTypeDef(TypedDict):
    returnValue: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetResourcePoliciesResponseTypeDef#

# GetResourcePoliciesResponseTypeDef definition

class GetResourcePoliciesResponseTypeDef(TypedDict):
    policies: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PromoteResourceShareCreatedFromPolicyResponseTypeDef#

# PromoteResourceShareCreatedFromPolicyResponseTypeDef definition

class PromoteResourceShareCreatedFromPolicyResponseTypeDef(TypedDict):
    returnValue: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SetDefaultPermissionVersionResponseTypeDef#

# SetDefaultPermissionVersionResponseTypeDef definition

class SetDefaultPermissionVersionResponseTypeDef(TypedDict):
    returnValue: bool,
    clientToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef