Table of Contents
A low-level client representing AWS Resource Access Manager (RAM)
This is the Resource Access Manager API Reference . This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts and within your organization or organizational units (OUs) in Organizations. For supported resource types, you can also share resources with IAM roles and IAM users. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts.
To learn more about RAM, see the following resources:
import boto3
client = boto3.client('ram')
These are the available methods:
Accepts an invitation to a resource share from another Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.accept_resource_share_invitation(
resourceShareInvitationArn='string',
clientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the invitation.
dict
Response Syntax
{
'resourceShareInvitation': {
'resourceShareInvitationArn': 'string',
'resourceShareName': 'string',
'resourceShareArn': 'string',
'senderAccountId': 'string',
'receiverAccountId': 'string',
'invitationTimestamp': datetime(2015, 1, 1),
'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'receiverArn': 'string'
},
'clientToken': 'string'
}
Response Structure
(dict) --
resourceShareInvitation (dict) --
Information about the invitation.
resourceShareInvitationArn (string) --
The Amazon Resource Name (ARN) of the invitation.
resourceShareName (string) --
The name of the resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
senderAccountId (string) --
The ID of the Amazon Web Services account that sent the invitation.
receiverAccountId (string) --
The ID of the Amazon Web Services account that received the invitation.
invitationTimestamp (datetime) --
The date and time when the invitation was sent.
status (string) --
The status of the invitation.
resourceShareAssociations (list) --
To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
receiverArn (string) --
The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Associates the specified resource share with the specified principals and resources.
See also: AWS API Documentation
Request Syntax
response = client.associate_resource_share(
resourceShareArn='string',
resourceArns=[
'string',
],
principals=[
'string',
],
clientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
The Amazon Resource Names (ARNs) of the resources.
The principals to associate with the resource share. The possible values are:
Note
Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide .
dict
Response Syntax
{
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'clientToken': 'string'
}
Response Structure
(dict) --
resourceShareAssociations (list) --
Information about the associations.
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Associates a permission with a resource share.
See also: AWS API Documentation
Request Syntax
response = client.associate_resource_share_permission(
resourceShareArn='string',
permissionArn='string',
replace=True|False,
clientToken='string',
permissionVersion=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
[REQUIRED]
The Amazon Resource Name (ARN) of the RAM permission to associate with the resource share.
dict
Response Syntax
{
'returnValue': True|False,
'clientToken': 'string'
}
Response Structure
(dict) --
returnValue (boolean) --
Indicates whether the request succeeded.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Check if an operation can be paginated.
Creates a resource share. You must provide a list of the Amazon Resource Names (ARNs) for the resources you want to share. You must also specify who you want to share the resources with, and the permissions that you grant them.
Note
Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.
See also: AWS API Documentation
Request Syntax
response = client.create_resource_share(
name='string',
resourceArns=[
'string',
],
principals=[
'string',
],
tags=[
{
'key': 'string',
'value': 'string'
},
],
allowExternalPrincipals=True|False,
clientToken='string',
permissionArns=[
'string',
]
)
[REQUIRED]
The name of the resource share.
The ARNs of the resources to associate with the resource share.
The principals to associate with the resource share. The possible values are:
Note
Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide .
One or more tags.
Information about a tag.
The key of the tag.
The value of the tag.
The Amazon Resource Names (ARNs) of the permissions to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. Only one permission can be associated with each resource type in a resource share.
dict
Response Syntax
{
'resourceShare': {
'resourceShareArn': 'string',
'name': 'string',
'owningAccountId': 'string',
'allowExternalPrincipals': True|False,
'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
'statusMessage': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
},
'clientToken': 'string'
}
Response Structure
(dict) --
resourceShare (dict) --
Information about the resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
name (string) --
The name of the resource share.
owningAccountId (string) --
The ID of the Amazon Web Services account that owns the resource share.
allowExternalPrincipals (boolean) --
Indicates whether principals outside your organization in Organizations can be associated with a resource share.
status (string) --
The status of the resource share.
statusMessage (string) --
A message about the status of the resource share.
tags (list) --
The tags for the resource share.
(dict) --
Information about a tag.
key (string) --
The key of the tag.
value (string) --
The value of the tag.
creationTime (datetime) --
The time when the resource share was created.
lastUpdatedTime (datetime) --
The time when the resource share was last updated.
featureSet (string) --
Indicates how the resource share was created. Possible values include:
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Deletes the specified resource share.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_share(
resourceShareArn='string',
clientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
dict
Response Syntax
{
'returnValue': True|False,
'clientToken': 'string'
}
Response Structure
(dict) --
returnValue (boolean) --
Indicates whether the request succeeded.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Disassociates the specified principals or resources from the specified resource share.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_resource_share(
resourceShareArn='string',
resourceArns=[
'string',
],
principals=[
'string',
],
clientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
The Amazon Resource Names (ARNs) of the resources.
The principals.
dict
Response Syntax
{
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'clientToken': 'string'
}
Response Structure
(dict) --
resourceShareAssociations (list) --
Information about the associations.
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Disassociates an RAM permission from a resource share.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_resource_share_permission(
resourceShareArn='string',
permissionArn='string',
clientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
[REQUIRED]
The Amazon Resource Name (ARN) of the permission to disassociate from the resource share.
dict
Response Syntax
{
'returnValue': True|False,
'clientToken': 'string'
}
Response Structure
(dict) --
returnValue (boolean) --
Indicates whether the request succeeded.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Enables resource sharing within your organization in Organizations.
The caller must be the master account for the organization.
See also: AWS API Documentation
Request Syntax
response = client.enable_sharing_with_aws_organization()
{
'returnValue': True|False
}
Response Structure
Indicates whether the request succeeded.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Gets the contents of an RAM permission in JSON format.
See also: AWS API Documentation
Request Syntax
response = client.get_permission(
permissionArn='string',
permissionVersion=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the permission.
dict
Response Syntax
{
'permission': {
'arn': 'string',
'version': 'string',
'defaultVersion': True|False,
'name': 'string',
'resourceType': 'string',
'permission': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'isResourceTypeDefault': True|False
}
}
Response Structure
(dict) --
permission (dict) --
Information about the permission.
arn (string) --
The Amazon Resource Name (ARN) of the permission.
version (string) --
The identifier for the version of the permission.
defaultVersion (boolean) --
Specifies whether the version of the permission is set to the default version for this permission.
name (string) --
The name of the permission.
resourceType (string) --
The resource type to which the permission applies.
permission (string) --
The permission's effect and actions in JSON format. The effect indicates whether the actions are allowed or denied. The actions list the API actions to which the principal is granted or denied access.
creationTime (datetime) --
The date and time when the permission was created.
lastUpdatedTime (datetime) --
The date and time when the permission was last updated.
isResourceTypeDefault (boolean) --
Specifies whether the version of the permission is set to the default version for this resource type.
Exceptions
Gets the policies for the specified resources that you own and have shared.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_policies(
resourceArns=[
'string',
],
principal='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The Amazon Resource Names (ARNs) of the resources.
dict
Response Syntax
{
'policies': [
'string',
],
'nextToken': 'string'
}
Response Structure
(dict) --
policies (list) --
A key policy document, in JSON format.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Gets the resources or principals for the resource shares that you own.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_share_associations(
associationType='PRINCIPAL'|'RESOURCE',
resourceShareArns=[
'string',
],
resourceArn='string',
principal='string',
associationStatus='ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
nextToken='string',
maxResults=123
)
[REQUIRED]
The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.
The Amazon Resource Names (ARN) of the resource shares.
dict
Response Syntax
{
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resourceShareAssociations (list) --
Information about the associations.
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Gets the invitations that you have received for resource shares.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_share_invitations(
resourceShareInvitationArns=[
'string',
],
resourceShareArns=[
'string',
],
nextToken='string',
maxResults=123
)
The Amazon Resource Names (ARN) of the invitations.
The Amazon Resource Names (ARN) of the resource shares.
dict
Response Syntax
{
'resourceShareInvitations': [
{
'resourceShareInvitationArn': 'string',
'resourceShareName': 'string',
'resourceShareArn': 'string',
'senderAccountId': 'string',
'receiverAccountId': 'string',
'invitationTimestamp': datetime(2015, 1, 1),
'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'receiverArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resourceShareInvitations (list) --
Information about the invitations.
(dict) --
Describes an invitation to join a resource share.
resourceShareInvitationArn (string) --
The Amazon Resource Name (ARN) of the invitation.
resourceShareName (string) --
The name of the resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
senderAccountId (string) --
The ID of the Amazon Web Services account that sent the invitation.
receiverAccountId (string) --
The ID of the Amazon Web Services account that received the invitation.
invitationTimestamp (datetime) --
The date and time when the invitation was sent.
status (string) --
The status of the invitation.
resourceShareAssociations (list) --
To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
receiverArn (string) --
The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Gets the resource shares that you own or the resource shares that are shared with you.
See also: AWS API Documentation
Request Syntax
response = client.get_resource_shares(
resourceShareArns=[
'string',
],
resourceShareStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
resourceOwner='SELF'|'OTHER-ACCOUNTS',
name='string',
tagFilters=[
{
'tagKey': 'string',
'tagValues': [
'string',
]
},
],
nextToken='string',
maxResults=123,
permissionArn='string'
)
The Amazon Resource Names (ARNs) of the resource shares.
[REQUIRED]
The type of owner.
One or more tag filters.
Used to filter information based on tags.
The tag key.
The tag values.
dict
Response Syntax
{
'resourceShares': [
{
'resourceShareArn': 'string',
'name': 'string',
'owningAccountId': 'string',
'allowExternalPrincipals': True|False,
'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
'statusMessage': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resourceShares (list) --
Information about the resource shares.
(dict) --
Describes a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
name (string) --
The name of the resource share.
owningAccountId (string) --
The ID of the Amazon Web Services account that owns the resource share.
allowExternalPrincipals (boolean) --
Indicates whether principals outside your organization in Organizations can be associated with a resource share.
status (string) --
The status of the resource share.
statusMessage (string) --
A message about the status of the resource share.
tags (list) --
The tags for the resource share.
(dict) --
Information about a tag.
key (string) --
The key of the tag.
value (string) --
The value of the tag.
creationTime (datetime) --
The time when the resource share was created.
lastUpdatedTime (datetime) --
The time when the resource share was last updated.
featureSet (string) --
Indicates how the resource share was created. Possible values include:
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Returns an object that can wait for some condition.
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
See also: AWS API Documentation
Request Syntax
response = client.list_pending_invitation_resources(
resourceShareInvitationArn='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the invitation.
dict
Response Syntax
{
'resources': [
{
'arn': 'string',
'type': 'string',
'resourceShareArn': 'string',
'resourceGroupArn': 'string',
'status': 'AVAILABLE'|'ZONAL_RESOURCE_INACCESSIBLE'|'LIMIT_EXCEEDED'|'UNAVAILABLE'|'PENDING',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resources (list) --
Information about the resources included the resource share.
(dict) --
Describes a resource associated with a resource share.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
type (string) --
The resource type.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceGroupArn (string) --
The Amazon Resource Name (ARN) of the resource group. This value is returned only if the resource is a resource group.
status (string) --
The status of the resource.
statusMessage (string) --
A message about the status of the resource.
creationTime (datetime) --
The time when the resource was associated with the resource share.
lastUpdatedTime (datetime) --
The time when the association was last updated.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Lists the RAM permissions.
See also: AWS API Documentation
Request Syntax
response = client.list_permissions(
resourceType='string',
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'permissions': [
{
'arn': 'string',
'version': 'string',
'defaultVersion': True|False,
'name': 'string',
'resourceType': 'string',
'status': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'isResourceTypeDefault': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
permissions (list) --
Information about the permissions.
(dict) --
Information about a permission that is associated with a resource share.
arn (string) --
The Amazon Resource Name (ARN) of the permission.
version (string) --
The identifier for the version of the permission.
defaultVersion (boolean) --
Specifies whether the version of the permission is set to the default version for this permission.
name (string) --
The name of the permission.
resourceType (string) --
The type of resource to which the permission applies.
status (string) --
The current status of the permission.
creationTime (datetime) --
The date and time when the permission was created.
lastUpdatedTime (datetime) --
The date and time when the permission was last updated.
isResourceTypeDefault (boolean) --
Specifies whether the version of the permission is set to the default version for this resource type.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Lists the principals that you have shared resources with or that have shared resources with you.
See also: AWS API Documentation
Request Syntax
response = client.list_principals(
resourceOwner='SELF'|'OTHER-ACCOUNTS',
resourceArn='string',
principals=[
'string',
],
resourceType='string',
resourceShareArns=[
'string',
],
nextToken='string',
maxResults=123
)
[REQUIRED]
The type of owner.
The principals.
The resource type.
Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
The Amazon Resource Names (ARN) of the resource shares.
dict
Response Syntax
{
'principals': [
{
'id': 'string',
'resourceShareArn': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
principals (list) --
The principals.
(dict) --
Describes a principal for use with Resource Access Manager.
id (string) --
The ID of the principal.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
creationTime (datetime) --
The time when the principal was associated with the resource share.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Lists the RAM permissions that are associated with a resource share.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_share_permissions(
resourceShareArn='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
dict
Response Syntax
{
'permissions': [
{
'arn': 'string',
'version': 'string',
'defaultVersion': True|False,
'name': 'string',
'resourceType': 'string',
'status': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'isResourceTypeDefault': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
permissions (list) --
The permissions associated with the resource share.
(dict) --
Information about a permission that is associated with a resource share.
arn (string) --
The Amazon Resource Name (ARN) of the permission.
version (string) --
The identifier for the version of the permission.
defaultVersion (boolean) --
Specifies whether the version of the permission is set to the default version for this permission.
name (string) --
The name of the permission.
resourceType (string) --
The type of resource to which the permission applies.
status (string) --
The current status of the permission.
creationTime (datetime) --
The date and time when the permission was created.
lastUpdatedTime (datetime) --
The date and time when the permission was last updated.
isResourceTypeDefault (boolean) --
Specifies whether the version of the permission is set to the default version for this resource type.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Lists the shareable resource types supported by RAM.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_types(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'resourceTypes': [
{
'resourceType': 'string',
'serviceName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resourceTypes (list) --
The shareable resource types supported by RAM.
(dict) --
Information about the shareable resource types and the Amazon Web Services services to which they belong.
resourceType (string) --
The shareable resource types.
serviceName (string) --
The name of the Amazon Web Services services to which the resources belong.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Lists the resources that you added to a resource shares or the resources that are shared with you.
See also: AWS API Documentation
Request Syntax
response = client.list_resources(
resourceOwner='SELF'|'OTHER-ACCOUNTS',
principal='string',
resourceType='string',
resourceArns=[
'string',
],
resourceShareArns=[
'string',
],
nextToken='string',
maxResults=123
)
[REQUIRED]
The type of owner.
The resource type.
Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
The Amazon Resource Names (ARNs) of the resources.
The Amazon Resource Names (ARN) of the resource shares.
dict
Response Syntax
{
'resources': [
{
'arn': 'string',
'type': 'string',
'resourceShareArn': 'string',
'resourceGroupArn': 'string',
'status': 'AVAILABLE'|'ZONAL_RESOURCE_INACCESSIBLE'|'LIMIT_EXCEEDED'|'UNAVAILABLE'|'PENDING',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resources (list) --
Information about the resources.
(dict) --
Describes a resource associated with a resource share.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
type (string) --
The resource type.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceGroupArn (string) --
The Amazon Resource Name (ARN) of the resource group. This value is returned only if the resource is a resource group.
status (string) --
The status of the resource.
statusMessage (string) --
A message about the status of the resource.
creationTime (datetime) --
The time when the resource was associated with the resource share.
lastUpdatedTime (datetime) --
The time when the association was last updated.
nextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in RAM.
Use this API action to promote the resource share. When you promote the resource share, it becomes:
See also: AWS API Documentation
Request Syntax
response = client.promote_resource_share_created_from_policy(
resourceShareArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share to promote.
{
'returnValue': True|False
}
Response Structure
Indicates whether the request succeeded.
Exceptions
Rejects an invitation to a resource share from another Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.reject_resource_share_invitation(
resourceShareInvitationArn='string',
clientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the invitation.
dict
Response Syntax
{
'resourceShareInvitation': {
'resourceShareInvitationArn': 'string',
'resourceShareName': 'string',
'resourceShareArn': 'string',
'senderAccountId': 'string',
'receiverAccountId': 'string',
'invitationTimestamp': datetime(2015, 1, 1),
'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'receiverArn': 'string'
},
'clientToken': 'string'
}
Response Structure
(dict) --
resourceShareInvitation (dict) --
Information about the invitation.
resourceShareInvitationArn (string) --
The Amazon Resource Name (ARN) of the invitation.
resourceShareName (string) --
The name of the resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
senderAccountId (string) --
The ID of the Amazon Web Services account that sent the invitation.
receiverAccountId (string) --
The ID of the Amazon Web Services account that received the invitation.
invitationTimestamp (datetime) --
The date and time when the invitation was sent.
status (string) --
The status of the invitation.
resourceShareAssociations (list) --
To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
receiverArn (string) --
The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
Adds the specified tags to the specified resource share that you own.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceShareArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
[REQUIRED]
One or more tags.
Information about a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes the specified tags from the specified resource share that you own.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceShareArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
[REQUIRED]
The tag keys of the tags to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates the specified resource share that you own.
See also: AWS API Documentation
Request Syntax
response = client.update_resource_share(
resourceShareArn='string',
name='string',
allowExternalPrincipals=True|False,
clientToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
dict
Response Syntax
{
'resourceShare': {
'resourceShareArn': 'string',
'name': 'string',
'owningAccountId': 'string',
'allowExternalPrincipals': True|False,
'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
'statusMessage': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
},
'clientToken': 'string'
}
Response Structure
(dict) --
resourceShare (dict) --
Information about the resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
name (string) --
The name of the resource share.
owningAccountId (string) --
The ID of the Amazon Web Services account that owns the resource share.
allowExternalPrincipals (boolean) --
Indicates whether principals outside your organization in Organizations can be associated with a resource share.
status (string) --
The status of the resource share.
statusMessage (string) --
A message about the status of the resource share.
tags (list) --
The tags for the resource share.
(dict) --
Information about a tag.
key (string) --
The key of the tag.
value (string) --
The value of the tag.
creationTime (datetime) --
The time when the resource share was created.
lastUpdatedTime (datetime) --
The time when the resource share was last updated.
featureSet (string) --
Indicates how the resource share was created. Possible values include:
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Exceptions
The available paginators are:
paginator = client.get_paginator('get_resource_policies')
Creates an iterator that will paginate through responses from RAM.Client.get_resource_policies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceArns=[
'string',
],
principal='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Names (ARNs) of the resources.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'policies': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
policies (list) --
A key policy document, in JSON format.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('get_resource_share_associations')
Creates an iterator that will paginate through responses from RAM.Client.get_resource_share_associations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
associationType='PRINCIPAL'|'RESOURCE',
resourceShareArns=[
'string',
],
resourceArn='string',
principal='string',
associationStatus='ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.
The Amazon Resource Names (ARN) of the resource shares.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resourceShareAssociations (list) --
Information about the associations.
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('get_resource_share_invitations')
Creates an iterator that will paginate through responses from RAM.Client.get_resource_share_invitations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceShareInvitationArns=[
'string',
],
resourceShareArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Names (ARN) of the invitations.
The Amazon Resource Names (ARN) of the resource shares.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resourceShareInvitations': [
{
'resourceShareInvitationArn': 'string',
'resourceShareName': 'string',
'resourceShareArn': 'string',
'senderAccountId': 'string',
'receiverAccountId': 'string',
'invitationTimestamp': datetime(2015, 1, 1),
'status': 'PENDING'|'ACCEPTED'|'REJECTED'|'EXPIRED',
'resourceShareAssociations': [
{
'resourceShareArn': 'string',
'resourceShareName': 'string',
'associatedEntity': 'string',
'associationType': 'PRINCIPAL'|'RESOURCE',
'status': 'ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'receiverArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resourceShareInvitations (list) --
Information about the invitations.
(dict) --
Describes an invitation to join a resource share.
resourceShareInvitationArn (string) --
The Amazon Resource Name (ARN) of the invitation.
resourceShareName (string) --
The name of the resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
senderAccountId (string) --
The ID of the Amazon Web Services account that sent the invitation.
receiverAccountId (string) --
The ID of the Amazon Web Services account that received the invitation.
invitationTimestamp (datetime) --
The date and time when the invitation was sent.
status (string) --
The status of the invitation.
resourceShareAssociations (list) --
To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .
(dict) --
Describes an association with a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceShareName (string) --
The name of the resource share.
associatedEntity (string) --
The associated entity. For resource associations, this is the Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:
associationType (string) --
The association type.
status (string) --
The status of the association.
statusMessage (string) --
A message about the status of the association.
creationTime (datetime) --
The time when the association was created.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
receiverArn (string) --
The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('get_resource_shares')
Creates an iterator that will paginate through responses from RAM.Client.get_resource_shares().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceShareArns=[
'string',
],
resourceShareStatus='PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
resourceOwner='SELF'|'OTHER-ACCOUNTS',
name='string',
tagFilters=[
{
'tagKey': 'string',
'tagValues': [
'string',
]
},
],
permissionArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The Amazon Resource Names (ARNs) of the resource shares.
[REQUIRED]
The type of owner.
One or more tag filters.
Used to filter information based on tags.
The tag key.
The tag values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resourceShares': [
{
'resourceShareArn': 'string',
'name': 'string',
'owningAccountId': 'string',
'allowExternalPrincipals': True|False,
'status': 'PENDING'|'ACTIVE'|'FAILED'|'DELETING'|'DELETED',
'statusMessage': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resourceShares (list) --
Information about the resource shares.
(dict) --
Describes a resource share.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
name (string) --
The name of the resource share.
owningAccountId (string) --
The ID of the Amazon Web Services account that owns the resource share.
allowExternalPrincipals (boolean) --
Indicates whether principals outside your organization in Organizations can be associated with a resource share.
status (string) --
The status of the resource share.
statusMessage (string) --
A message about the status of the resource share.
tags (list) --
The tags for the resource share.
(dict) --
Information about a tag.
key (string) --
The key of the tag.
value (string) --
The value of the tag.
creationTime (datetime) --
The time when the resource share was created.
lastUpdatedTime (datetime) --
The time when the resource share was last updated.
featureSet (string) --
Indicates how the resource share was created. Possible values include:
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_principals')
Creates an iterator that will paginate through responses from RAM.Client.list_principals().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceOwner='SELF'|'OTHER-ACCOUNTS',
resourceArn='string',
principals=[
'string',
],
resourceType='string',
resourceShareArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The type of owner.
The principals.
The resource type.
Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
The Amazon Resource Names (ARN) of the resource shares.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'principals': [
{
'id': 'string',
'resourceShareArn': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'external': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
principals (list) --
The principals.
(dict) --
Describes a principal for use with Resource Access Manager.
id (string) --
The ID of the principal.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
creationTime (datetime) --
The time when the principal was associated with the resource share.
lastUpdatedTime (datetime) --
The time when the association was last updated.
external (boolean) --
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_resources')
Creates an iterator that will paginate through responses from RAM.Client.list_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceOwner='SELF'|'OTHER-ACCOUNTS',
principal='string',
resourceType='string',
resourceArns=[
'string',
],
resourceShareArns=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The type of owner.
The resource type.
Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
The Amazon Resource Names (ARNs) of the resources.
The Amazon Resource Names (ARN) of the resource shares.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resources': [
{
'arn': 'string',
'type': 'string',
'resourceShareArn': 'string',
'resourceGroupArn': 'string',
'status': 'AVAILABLE'|'ZONAL_RESOURCE_INACCESSIBLE'|'LIMIT_EXCEEDED'|'UNAVAILABLE'|'PENDING',
'statusMessage': 'string',
'creationTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resources (list) --
Information about the resources.
(dict) --
Describes a resource associated with a resource share.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
type (string) --
The resource type.
resourceShareArn (string) --
The Amazon Resource Name (ARN) of the resource share.
resourceGroupArn (string) --
The Amazon Resource Name (ARN) of the resource group. This value is returned only if the resource is a resource group.
status (string) --
The status of the resource.
statusMessage (string) --
A message about the status of the resource.
creationTime (datetime) --
The time when the resource was associated with the resource share.
lastUpdatedTime (datetime) --
The time when the association was last updated.
NextToken (string) --
A token to resume pagination.