String resourceShareInvitationArn
The Amazon Resource Name (ARN) of the invitation that you want to accept.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
ResourceShareInvitation resourceShareInvitation
An object that contains information about the specified invitation.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String arn
The Amazon Resource Name (ARN) of the associated managed permission.
String permissionVersion
The version of the permission currently associated with the resource share.
Boolean defaultVersion
Indicates whether the associated resource share is using the default version of the permission.
String resourceType
The resource type to which this permission applies.
String status
The current status of the association between the permission and the resource share. The following are the possible values:
ATTACHABLE – This permission or version can be associated with resource shares.
UNATTACHABLE – This permission or version can't currently be associated with resource shares.
DELETING – This permission or version is in the process of being deleted.
DELETED – This permission or version is deleted.
String featureSet
Indicates what features are available for this resource share. This parameter can have one of the following values:
STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the
customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value
changes to STANDARD when complete.
Date lastUpdatedTime
The date and time when the association between the permission and the resource share was last updated.
String resourceShareArn
The Amazon Resource Name (ARN) of a resource share associated with this permission.
String resourceShareArn
Specifies the Amazon Resource Name (ARN) of the resource share to which you want to add or replace permissions.
String permissionArn
Specifies the Amazon Resource Name (ARN) of the RAM permission to associate with the resource share. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.
Boolean replace
Specifies whether the specified permission should replace the existing permission associated with the resource
share. Use true to replace the current permissions. Use false to add the permission to
a resource share that currently doesn't have a permission. The default value is false.
A resource share can have only one permission per resource type. If a resource share already has a permission for
the specified resource type and you don't set replace to true then the operation
returns an error. This helps prevent accidental overwriting of a permission.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
Integer permissionVersion
Specifies the version of the RAM permission to associate with the resource share. You can specify only the
version that is currently set as the default version for the permission. If you also set the replace
pararameter to true, then this operation updates an outdated version of the permission to the
current default version.
You don't need to specify this parameter because the default behavior is to use the version that is currently set as the default version for the permission. This parameter is supported for backwards compatibility.
Boolean returnValue
A return value of true indicates that the request succeeded. A value of false indicates
that the request failed.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String resourceShareArn
Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.
List<E> resourceArns
Specifies a list of Amazon
Resource Names (ARNs) of the resources that you want to share. This can be null if you want to
add only principals.
List<E> principals
Specifies a list of principals to whom you want to the resource share. This can be null if you want
to add only resources.
What the principals can do with the resources in the share is determined by the RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.
You can include the following values:
An Amazon Web Services account ID, for example: 123456789012
An Amazon Resource Name
(ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
An ARN of an IAM role, for example: iam::123456789012:role/rolename
An ARN of an IAM user, for example: iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
List<E> sources
Specifies from which source accounts the service principal has access to the resources in this resource share.
List<E> resourceShareAssociations
An array of objects that contain information about the associations.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String name
Specifies the name of the customer managed permission. The name must be unique within the Amazon Web Services Region.
String resourceType
Specifies the name of the resource type that this customer managed permission applies to.
The format is <service-code>:<resource-type> and is not case sensitive.
For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet. To see the list of
valid values for this parameter, query the ListResourceTypes operation.
String policyTemplate
A string in JSON format string that contains the following elements of a resource-based policy:
Effect: must be set to ALLOW.
Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.
Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.
This template can't include either the Resource or Principal elements. Those are both
filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed
permission. The Resource comes from the ARN of the specific resource that you are sharing. The
Principal comes from the list of identities added to the resource share.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
List<E> tags
Specifies a list of one or more tag key and value pairs to attach to the permission.
ResourceSharePermissionSummary permission
A structure with information about this customer managed permission.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String permissionArn
Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.
String policyTemplate
A string in JSON format string that contains the following elements of a resource-based policy:
Effect: must be set to ALLOW.
Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.
Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.
This template can't include either the Resource or Principal elements. Those are both
filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed
permission. The Resource comes from the ARN of the specific resource that you are sharing. The
Principal comes from the list of identities added to the resource share.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
ResourceSharePermissionDetail permission
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String name
Specifies the name of the resource share.
List<E> resourceArns
Specifies a list of one or more ARNs of the resources to associate with the resource share.
List<E> principals
Specifies a list of one or more principals to associate with the resource share.
You can include the following values:
An Amazon Web Services account ID, for example: 123456789012
An Amazon Resource Name
(ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
An ARN of an IAM role, for example: iam::123456789012:role/rolename
An ARN of an IAM user, for example: iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
List<E> tags
Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share.
Boolean allowExternalPrincipals
Specifies whether principals outside your organization in Organizations can be associated with a resource share.
A value of true lets you share with individual Amazon Web Services accounts that are not in
your organization. A value of false only has meaning if your account is a member of an Amazon Web
Services Organization. The default value is true.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
List<E> permissionArns
Specifies the Amazon Resource Names (ARNs) of the RAM permission 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. You can associate only one permission with each resource type included in the resource share.
List<E> sources
Specifies from which source accounts the service principal has access to the resources in this resource share.
ResourceShare resourceShare
An object with information about the new resource share.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String permissionArn
Specifies the Amazon Resource Name (ARN) of the customer managed permission that you want to delete.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
Boolean returnValue
A boolean that indicates whether the delete operations succeeded.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String permissionStatus
This operation is performed asynchronously, and this response parameter indicates the current status.
String permissionArn
Specifies the Amazon Resource Name (ARN) of the permission with the version you want to delete.
Integer permissionVersion
Specifies the version number to delete.
You can't delete the default version for a customer managed permission.
You can't delete a version if it's the only version of the permission. You must either first create another version, or delete the permission completely.
You can't delete a version if it is attached to any resource shares. If the version is the default, you must first use SetDefaultPermissionVersion to set a different version as the default for the customer managed permission, and then use AssociateResourceSharePermission to update your resource shares to use the new default version.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
Boolean returnValue
A boolean value that indicates whether the operation is successful.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String permissionStatus
This operation is performed asynchronously, and this response parameter indicates the current status.
String resourceShareArn
Specifies the Amazon Resource Name (ARN) of the resource share to delete.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
Boolean returnValue
A return value of true indicates that the request succeeded. A value of false indicates
that the request failed.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String resourceShareArn
The Amazon Resource Name (ARN) of the resource share that you want to remove the managed permission from.
String permissionArn
The Amazon Resource Name (ARN) of the managed permission to disassociate from the resource share. Changes to permissions take effect immediately.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
Boolean returnValue
A return value of true indicates that the request succeeded. A value of false indicates
that the request failed.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String resourceShareArn
Specifies Amazon Resource Name (ARN) of the resource share that you want to remove resources or principals from.
List<E> resourceArns
Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals associated with the resource share.
List<E> principals
Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.
You can include the following values:
An Amazon Web Services account ID, for example: 123456789012
An Amazon Resource Name
(ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
An ARN of an IAM role, for example: iam::123456789012:role/rolename
An ARN of an IAM user, for example: iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
List<E> sources
Specifies from which source accounts the service principal no longer has access to the resources in this resource share.
List<E> resourceShareAssociations
An array of objects with information about the updated associations for this resource share.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
Boolean returnValue
A return value of true indicates that the request succeeded. A value of false indicates
that the request failed.
String permissionArn
Specifies the Amazon Resource Name (ARN) of the permission whose contents you want to retrieve. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.
Integer permissionVersion
Specifies the version number of the RAM permission to retrieve. If you don't specify this parameter, the operation retrieves the default version.
To see the list of available versions, use ListPermissionVersions.
ResourceSharePermissionDetail permission
An object with details about the permission.
List<E> resourceArns
Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.
String principal
Specifies the principal.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> policies
An array of resource policy documents in JSON format.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String associationType
Specifies whether you want to retrieve the associations that involve a specified resource or principal.
PRINCIPAL – list the principals whose associations you want to see.
RESOURCE – list the resources whose associations you want to see.
List<E> resourceShareArns
Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.
String resourceArn
Specifies the Amazon Resource Name (ARN) of a resource whose resource shares you want to retrieve.
You cannot specify this parameter if the association type is PRINCIPAL.
String principal
Specifies the ID of the principal whose resource shares you want to retrieve. This can be an Amazon Web Services account ID, an organization ID, an organizational unit ID, or the Amazon Resource Name (ARN) of an individual IAM role or user.
You cannot specify this parameter if the association type is RESOURCE.
String associationStatus
Specifies that you want to retrieve only associations that have this status.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> resourceShareAssociations
An array of objects that contain the details about the associations.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
List<E> resourceShareInvitationArns
Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.
List<E> resourceShareArns
Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> resourceShareInvitations
An array of objects that contain the details about the invitations.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
List<E> resourceShareArns
Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.
String resourceShareStatus
Specifies that you want to retrieve details of only those resource shares that have this status.
String resourceOwner
Specifies that you want to retrieve details of only those resource shares that match the following:
SELF – resource shares that your account shares with other accounts
OTHER-ACCOUNTS – resource shares that other accounts share with your account
String name
Specifies the name of an individual resource share that you want to retrieve details about.
List<E> tagFilters
Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
String permissionArn
Specifies that you want to retrieve details of only those resource shares that use the managed permission with this Amazon Resource Name (ARN).
Integer permissionVersion
Specifies that you want to retrieve details for only those resource shares that use the specified version of the managed permission.
List<E> resourceShares
An array of objects that contain the information about the resource shares.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String resourceShareInvitationArn
Specifies the Amazon Resource Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
String resourceRegionScope
Specifies that you want the results to include only resources that have the specified scope.
ALL – the results include both global and regional resources or resource types.
GLOBAL – the results include only global resources or resource types.
REGIONAL – the results include only regional resources or resource types.
The default value is ALL.
List<E> resources
An array of objects that contain the information about the resources included the specified resource share.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String permissionArn
Specifies the Amazon Resource Name (ARN) of the managed permission.
Integer permissionVersion
Specifies that you want to list only those associations with resource shares that use this version of the managed permission. If you don't provide a value for this parameter, then the operation returns information about associations with resource shares that use any version of the managed permission.
String associationStatus
Specifies that you want to list only those associations with resource shares that match this status.
String resourceType
Specifies that you want to list only those associations with resource shares that include at least one resource of this resource type.
String featureSet
Specifies that you want to list only those associations with resource shares that have a featureSet
with this value.
Boolean defaultVersion
When true, specifies that you want to list only those associations with resource shares that use the
default version of the specified managed permission.
When false (the default value), lists associations with resource shares that use any version of the
specified managed permission.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> permissions
A structure with information about this customer managed permission.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String resourceType
Specifies that you want to list only those permissions that apply to the specified resource type. This parameter is not case sensitive.
For example, to list only permissions that apply to Amazon EC2 subnets, specify ec2:subnet. You can
use the ListResourceTypes operation to get the specific string required.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
String permissionType
Specifies that you want to list only permissions of this type:
AWS – returns only Amazon Web Services managed permissions.
LOCAL – returns only customer managed permissions
ALL – returns both Amazon Web Services managed permissions and customer managed permissions.
If you don't specify this parameter, the default is All.
List<E> permissions
An array of objects with information about the permissions.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String permissionArn
Specifies the Amazon
Resource Name (ARN) of the RAM permission whose versions you want to list. You can use the
permissionVersion parameter on the AssociateResourceSharePermission operation to specify a
non-default version to attach.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> permissions
An array of objects that contain details for each of the available versions.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String resourceOwner
Specifies that you want to list information for only resource shares that match the following:
SELF – principals that your account is sharing resources with
OTHER-ACCOUNTS – principals that are sharing resources with your account
String resourceArn
Specifies that you want to list principal information for the resource share with the specified Amazon Resource Name (ARN).
List<E> principals
Specifies that you want to list information for only the listed principals.
You can include the following values:
An Amazon Web Services account ID, for example: 123456789012
An Amazon Resource Name
(ARN) of an organization in Organizations, for example:
organizations::123456789012:organization/o-exampleorgid
An ARN of an organizational unit (OU) in Organizations, for example:
organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
An ARN of an IAM role, for example: iam::123456789012:role/rolename
An ARN of an IAM user, for example: iam::123456789012user/username
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Resource Access Manager User Guide.
String resourceType
Specifies that you want to list information for only principals associated with resource shares that include the specified resource type.
For a list of valid values, query the ListResourceTypes operation.
List<E> resourceShareArns
Specifies that you want to list information for only principals associated with the resource shares specified by a list the Amazon Resource Names (ARNs).
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> principals
An array of objects that contain the details about the principals.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
List<E> workIds
A list of IDs. These values come from the idfield of the
replacePermissionAssociationsWorkstructure returned by the ReplacePermissionAssociations
operation.
String status
Specifies that you want to see only the details about requests with a status that matches this value.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> replacePermissionAssociationsWorks
An array of data structures that provide details of the matching work IDs.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String resourceShareArn
Specifies the Amazon Resource Name (ARN) of the resource share for which you want to retrieve the associated permissions.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
List<E> permissions
An array of objects that describe the permissions associated with the resource share.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String resourceOwner
Specifies that you want to list only the resource shares that match the following:
SELF – resources that your account shares with other accounts
OTHER-ACCOUNTS – resources that other accounts share with your account
String principal
Specifies that you want to list only the resource shares that are associated with the specified principal.
String resourceType
Specifies that you want to list only the resource shares that include resources of the specified resource type.
For valid values, query the ListResourceTypes operation.
List<E> resourceArns
Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).
List<E> resourceShareArns
Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
String resourceRegionScope
Specifies that you want the results to include only resources that have the specified scope.
ALL – the results include both global and regional resources or resource types.
GLOBAL – the results include only global resources or resource types.
REGIONAL – the results include only regional resources or resource types.
The default value is ALL.
List<E> resources
An array of objects that contain information about the resources.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String nextToken
Specifies that you want to receive the next page of results. Valid only if you received a NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to
the value provided by the previous call's NextToken response to request the next page of results.
Integer maxResults
Specifies the total number of results that you want included on each page of the response. If you do not include
this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the
number you specify, the NextToken response element is returned with a value (not null). Include the
specified value as the NextToken request parameter in the next call to the operation to get the next
part of the results. Note that the service might return fewer results than the maximum even when there are more
results available. You should check NextToken after every operation to ensure that you receive all
of the results.
String resourceRegionScope
Specifies that you want the results to include only resources that have the specified scope.
ALL – the results include both global and regional resources or resource types.
GLOBAL – the results include only global resources or resource types.
REGIONAL – the results include only regional resources or resource types.
The default value is ALL.
List<E> resourceTypes
An array of objects that contain information about the resource types that can be shared using RAM.
String nextToken
If present, this value indicates that more output is available than is included in the current response. Use this
value in the NextToken request parameter in a subsequent call to the operation to get the next part
of the output. You should repeat this until the NextToken response element comes back as
null. This indicates that this is the last page of results.
String id
The ID of the principal that can be associated with a resource share.
String resourceShareArn
The Amazon Resource Name (ARN) of a resource share the principal is associated with.
Date creationTime
The date and time when the principal was associated with the resource share.
Date lastUpdatedTime
The date and time when the association between the resource share and the principal was last updated.
Boolean external
Indicates the relationship between the Amazon Web Services account the principal belongs to and the account that owns the resource share:
True – The two accounts belong to same organization.
False – The two accounts do not belong to the same organization.
String permissionArn
Specifies the Amazon
Resource Name (ARN) of the CREATED_FROM_POLICY permission that you want to promote. You can get
this Amazon Resource Name
(ARN) by calling the ListResourceSharePermissions operation.
String name
Specifies a name for the promoted customer managed permission.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
ResourceSharePermissionSummary permission
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String resourceShareArn
Specifies the Amazon Resource Name (ARN) of the resource share to promote.
Boolean returnValue
A return value of true indicates that the request succeeded. A value of false indicates
that the request failed.
String resourceShareInvitationArn
Specifies the Amazon Resource Name (ARN) of the invitation that you want to reject.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
ResourceShareInvitation resourceShareInvitation
An object that contains the details about the rejected invitation.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String fromPermissionArn
Specifies the Amazon Resource Name (ARN) of the managed permission that you want to replace.
Integer fromPermissionVersion
Specifies that you want to updated the permissions for only those resource shares that use the specified version of the managed permission.
String toPermissionArn
Specifies the ARN of the managed permission that you want to associate with resource shares in place of the one
specified by fromPerssionArn and fromPermissionVersion.
The operation always associates the version that is currently the default for the specified managed permission.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
ReplacePermissionAssociationsWork replacePermissionAssociationsWork
Specifies a data structure that you can use to track the asynchronous tasks that RAM performs to complete this
operation. You can use the ListReplacePermissionAssociationsWork operation and pass the id
value returned in this structure.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String id
The unique identifier for the background task associated with one ReplacePermissionAssociations request.
String fromPermissionArn
The Amazon Resource Name (ARN) of the managed permission that this background task is replacing.
String fromPermissionVersion
The version of the managed permission that this background task is replacing.
String toPermissionArn
The ARN of the managed permission that this background task is associating with the resource shares in place of
the managed permission and version specified in fromPermissionArn and
fromPermissionVersion.
String toPermissionVersion
The version of the managed permission that this background task is associating with the resource shares. This is always the version that is currently the default for this managed permission.
String status
Specifies the current status of the background tasks for the specified ID. The output is one of the following strings:
IN_PROGRESS
COMPLETED
FAILED
String statusMessage
Specifies the reason for a FAILED status. This field is present only when there status
is FAILED.
Date creationTime
The date and time when this asynchronous background task was created.
Date lastUpdatedTime
The date and time when the status of this background task was last updated.
String arn
The Amazon Resource Name (ARN) of the resource.
String type
The resource type. This takes the form of: service-code:resource-code, and is
case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet.
String resourceShareArn
The Amazon Resource Name (ARN) of the resource share this resource is associated with.
String resourceGroupArn
The Amazon Resource Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.
String status
The current status of the resource.
String statusMessage
A message about the status of the resource.
Date creationTime
The date and time when the resource was associated with the resource share.
Date lastUpdatedTime
The date an time when the association between the resource and the resource share was last updated.
String resourceRegionScope
Specifies the scope of visibility of this resource:
REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.
GLOBAL – The resource can be accessed from any Amazon Web Services Region.
String resourceShareArn
The Amazon Resource Name (ARN) of the resource share
String name
The name of the resource share.
String owningAccountId
The ID of the Amazon Web Services account that owns the resource share.
Boolean allowExternalPrincipals
Indicates whether principals outside your organization in Organizations can be associated with a resource share.
True – the resource share can be shared with any Amazon Web Services account.
False – the resource share can be shared with only accounts in the same organization as the account
that owns the resource share.
String status
The current status of the resource share.
String statusMessage
A message about the status of the resource share.
List<E> tags
The tag key and value pairs attached to the resource share.
Date creationTime
The date and time when the resource share was created.
Date lastUpdatedTime
The date and time when the resource share was last updated.
String featureSet
Indicates what features are available for this resource share. This parameter can have one of the following values:
STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the
customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value
changes to STANDARD when complete.
String resourceShareArn
The Amazon Resource Name (ARN) of the resource share.
String resourceShareName
The name of the resource share.
String associatedEntity
The associated entity. This can be either of the following:
For a resource association, this is the Amazon Resource Name (ARN) of the resource.
For principal associations, this is one of the following:
The ID of an Amazon Web Services account
The Amazon Resource Name (ARN) of an organization in Organizations
The ARN of an organizational unit (OU) in Organizations
The ARN of an IAM role
The ARN of an IAM user
String associationType
The type of entity included in this association.
String status
The current status of the association.
String statusMessage
A message about the status of the association.
Date creationTime
The date and time when the association was created.
Date lastUpdatedTime
The date and time when the association was last updated.
Boolean external
Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.
String resourceShareInvitationArn
The Amazon Resource Name (ARN) of the invitation.
String resourceShareName
The name of the resource share.
String resourceShareArn
The Amazon Resource Name (ARN) of the resource share
String senderAccountId
The ID of the Amazon Web Services account that sent the invitation.
String receiverAccountId
The ID of the Amazon Web Services account that received the invitation.
Date invitationTimestamp
The date and time when the invitation was sent.
String status
The current status of the invitation.
List<E> resourceShareAssociations
To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.
String receiverArn
The Amazon Resource Name (ARN) of the IAM user or role that received the invitation.
String arn
The Amazon Resource Name (ARN) of this RAM managed permission.
String version
The version of the permission described in this response.
Boolean defaultVersion
Specifies whether the version of the permission represented in this response is the default version for this permission.
String name
The name of this permission.
String resourceType
The resource type to which this permission applies.
String permission
The permission's effect and actions in JSON format. The effect indicates whether the specified
actions are allowed or denied. The actions list the operations to which the principal is granted or
denied access.
Date creationTime
The date and time when the permission was created.
Date lastUpdatedTime
The date and time when the permission was last updated.
Boolean isResourceTypeDefault
Specifies whether the version of the permission represented in this response is the default version for all resources of this resource type.
String permissionType
The type of managed permission. This can be one of the following values:
AWS_MANAGED – Amazon Web Services created and manages this managed permission. You can associate it
with your resource shares, but you can't modify it.
CUSTOMER_MANAGED – You, or another principal in your account created this managed permission. You
can associate it with your resource shares and create new versions that have different permissions.
String featureSet
Indicates what features are available for this resource share. This parameter can have one of the following values:
STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the
customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value
changes to STANDARD when complete.
String status
The current status of the association between the permission and the resource share. The following are the possible values:
ATTACHABLE – This permission or version can be associated with resource shares.
UNATTACHABLE – This permission or version can't currently be associated with resource shares.
DELETING – This permission or version is in the process of being deleted.
DELETED – This permission or version is deleted.
List<E> tags
The tag key and value pairs attached to the resource share.
String arn
The Amazon Resource Name (ARN) of the permission you want information about.
String version
The version of the permission associated with this resource share.
Boolean defaultVersion
Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.
String name
The name of this managed permission.
String resourceType
The type of resource to which this permission applies. This takes the form of: service-code:
resource-code, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by
the string ec2:subnet.
String status
The current status of the permission.
Date creationTime
The date and time when the permission was created.
Date lastUpdatedTime
The date and time when the permission was last updated.
Boolean isResourceTypeDefault
Specifies whether the managed permission associated with this resource share is the default managed permission for all resources of this resource type.
String permissionType
The type of managed permission. This can be one of the following values:
AWS_MANAGED – Amazon Web Services created and manages this managed permission. You can associate it
with your resource shares, but you can't modify it.
CUSTOMER_MANAGED – You, or another principal in your account created this managed permission. You
can associate it with your resource shares and create new versions that have different permissions.
String featureSet
Indicates what features are available for this resource share. This parameter can have one of the following values:
STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer's behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can't modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the
customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value
changes to STANDARD when complete.
List<E> tags
A list of the tag key value pairs currently attached to the permission.
String resourceType
The type of the resource. This takes the form of: service-code:resource-code, and is
case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet.
String serviceName
The name of the Amazon Web Services service to which resources of this type belong.
String resourceRegionScope
Specifies the scope of visibility of resources of this type:
REGIONAL – The resource can be accessed only by using requests that target the Amazon Web Services Region in which the resource exists.
GLOBAL – The resource can be accessed from any Amazon Web Services Region.
String permissionArn
Specifies the Amazon Resource Name (ARN) of the customer managed permission whose default version you want to change.
Integer permissionVersion
Specifies the version number that you want to designate as the default for customer managed permission. To see a list of all available version numbers, use ListPermissionVersions.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
Boolean returnValue
A boolean value that indicates whether the operation was successful.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
String resourceShareArn
Specifies the Amazon
Resource Name (ARN) of the resource share that you want to add tags to. You must specify either
resourceShareArn, or resourceArn, but not both.
List<E> tags
A list of one or more tag key and value pairs. The tag key must be present and not be an empty string. The tag value must be present but can be an empty string.
String resourceArn
Specifies the Amazon
Resource Name (ARN) of the managed permission that you want to add tags to. You must specify either
resourceArn, or resourceShareArn, but not both.
String resourceShareArn
Specifies the Amazon
Resource Name (ARN) of the resource share that you want to remove tags from. The tags are removed from the
resource share, not the resources in the resource share. You must specify either resourceShareArn,
or resourceArn, but not both.
List<E> tagKeys
Specifies a list of one or more tag keys that you want to remove.
String resourceArn
Specifies the Amazon
Resource Name (ARN) of the managed permission that you want to remove tags from. You must specify either
resourceArn, or resourceShareArn, but not both.
String resourceShareArn
Specifies the Amazon Resource Name (ARN) of the resource share that you want to modify.
String name
If specified, the new name that you want to attach to the resource share.
Boolean allowExternalPrincipals
Specifies whether principals outside your organization in Organizations can be associated with a resource share.
String clientToken
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails
with an IdempotentParameterMismatch error.
ResourceShare resourceShare
Information about the resource share.
String clientToken
The idempotency identifier associated with this request. If you want to repeat the same operation in an
idempotent manner then you must include this value in the clientToken request parameter of that
later call. All other parameters must also have the same values that you used in the first call.
Copyright © 2024. All rights reserved.