2019/09/18
- AWS Resource Access Manager -
1 new 7 updated api methods
Changes
AWS RAM provides a new ListPendingInvitationResources API action that lists the resources in a resource share that is shared with you but that the invitation is still pending for
ListPendingInvitationResources (new)
Link ¶
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
client.list_pending_invitation_resources(
resourceShareInvitationArn='string',
nextToken='string',
maxResults=123
)
- type resourceShareInvitationArn
string
- param resourceShareInvitationArn
[REQUIRED]
The Amazon Resource Name (ARN) of the invitation.
- type nextToken
string
- param nextToken
The token for the next page of results.
- type maxResults
integer
- param maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
- rtype
dict
- returns
Response Syntax
{
'resources': [
{
'arn': 'string',
'type': 'string',
'resourceShareArn': '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
AcceptResourceShareInvitation (updated)
Link ¶
Changes (response)
{'resourceShareInvitation': {'resourceShareAssociations': {'resourceShareName': 'string'}}}
Accepts an invitation to a resource share from another AWS account.
See also: AWS API Documentation
Request Syntax
client.accept_resource_share_invitation(
resourceShareInvitationArn='string',
clientToken='string'
)
- type resourceShareInvitationArn
string
- param resourceShareInvitationArn
[REQUIRED]
The Amazon Resource Name (ARN) of the invitation.
- type clientToken
string
- param clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- rtype
dict
- returns
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
},
]
},
'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 AWS account that sent the invitation.
receiverAccountId (string) --
The ID of the AWS 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.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
AssociateResourceShare (updated)
Link ¶
Changes (response)
{'resourceShareAssociations': {'resourceShareName': 'string'}}
Associates the specified resource share with the specified principals and resources.
See also: AWS API Documentation
Request Syntax
client.associate_resource_share(
resourceShareArn='string',
resourceArns=[
'string',
],
principals=[
'string',
],
clientToken='string'
)
- type resourceShareArn
string
- param resourceShareArn
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
- type resourceArns
list
- param resourceArns
The Amazon Resource Names (ARN) of the resources.
- type principals
list
- param principals
The principals.
- type clientToken
string
- param clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- rtype
dict
- returns
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.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
DisassociateResourceShare (updated)
Link ¶
Changes (response)
{'resourceShareAssociations': {'resourceShareName': 'string'}}
Disassociates the specified principals or resources from the specified resource share.
See also: AWS API Documentation
Request Syntax
client.disassociate_resource_share(
resourceShareArn='string',
resourceArns=[
'string',
],
principals=[
'string',
],
clientToken='string'
)
- type resourceShareArn
string
- param resourceShareArn
[REQUIRED]
The Amazon Resource Name (ARN) of the resource share.
- type resourceArns
list
- param resourceArns
The Amazon Resource Names (ARN) of the resources.
- type principals
list
- param principals
The principals.
- type clientToken
string
- param clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- rtype
dict
- returns
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.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
GetResourceShareAssociations (updated)
Link ¶
Changes (response)
{'resourceShareAssociations': {'resourceShareName': 'string'}}
Gets the resources or principals for the resource shares that you own.
See also: AWS API Documentation
Request Syntax
client.get_resource_share_associations(
associationType='PRINCIPAL'|'RESOURCE',
resourceShareArns=[
'string',
],
resourceArn='string',
principal='string',
associationStatus='ASSOCIATING'|'ASSOCIATED'|'FAILED'|'DISASSOCIATING'|'DISASSOCIATED',
nextToken='string',
maxResults=123
)
- type associationType
string
- param associationType
[REQUIRED]
The association type.
- type resourceShareArns
list
- param resourceShareArns
The Amazon Resource Names (ARN) of the resource shares.
- type resourceArn
string
- param resourceArn
The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL .
- type principal
string
- param principal
The principal. You cannot specify this parameter if the association type is RESOURCE .
- type associationStatus
string
- param associationStatus
The association status.
- type nextToken
string
- param nextToken
The token for the next page of results.
- type maxResults
integer
- param maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
- rtype
dict
- returns
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.
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.
GetResourceShareInvitations (updated)
Link ¶
Changes (response)
{'resourceShareInvitations': {'resourceShareAssociations': {'resourceShareName': 'string'}}}
Gets the invitations for resource sharing that you've received.
See also: AWS API Documentation
Request Syntax
client.get_resource_share_invitations(
resourceShareInvitationArns=[
'string',
],
resourceShareArns=[
'string',
],
nextToken='string',
maxResults=123
)
- type resourceShareInvitationArns
list
- param resourceShareInvitationArns
The Amazon Resource Names (ARN) of the invitations.
- type resourceShareArns
list
- param resourceShareArns
The Amazon Resource Names (ARN) of the resource shares.
- type nextToken
string
- param nextToken
The token for the next page of results.
- type maxResults
integer
- param maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
- rtype
dict
- returns
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
},
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resourceShareInvitations (list) --
Information about the invitations.
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.
ListResources (updated)
Link ¶
Changes (response)
{'resources': {'status': {'PENDING'}}}
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
client.list_resources(
resourceOwner='SELF'|'OTHER-ACCOUNTS',
principal='string',
resourceType='string',
resourceArns=[
'string',
],
resourceShareArns=[
'string',
],
nextToken='string',
maxResults=123
)
- type resourceOwner
string
- param resourceOwner
[REQUIRED]
The type of owner.
- type principal
string
- param principal
The principal.
- type resourceType
string
- param resourceType
The resource type.
Valid values: route53resolver:ResolverRule | ec2:TransitGateway | ec2:Subnet | license-manager:LicenseConfiguration
- type resourceArns
list
- param resourceArns
The Amazon Resource Names (ARN) of the resources.
- type resourceShareArns
list
- param resourceShareArns
The Amazon Resource Names (ARN) of the resource shares.
- type nextToken
string
- param nextToken
The token for the next page of results.
- type maxResults
integer
- param maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
- rtype
dict
- returns
Response Syntax
{
'resources': [
{
'arn': 'string',
'type': 'string',
'resourceShareArn': '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
RejectResourceShareInvitation (updated)
Link ¶
Changes (response)
{'resourceShareInvitation': {'resourceShareAssociations': {'resourceShareName': 'string'}}}
Rejects an invitation to a resource share from another AWS account.
See also: AWS API Documentation
Request Syntax
client.reject_resource_share_invitation(
resourceShareInvitationArn='string',
clientToken='string'
)
- type resourceShareInvitationArn
string
- param resourceShareInvitationArn
[REQUIRED]
The Amazon Resource Name (ARN) of the invitation.
- type clientToken
string
- param clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
- rtype
dict
- returns
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
},
]
},
'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 AWS account that sent the invitation.
receiverAccountId (string) --
The ID of the AWS 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.
clientToken (string) --
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.