Serialized Form

Package com.amazonaws.services.ram.model

Class com.amazonaws.services.ram.model.AcceptResourceShareInvitationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareInvitationArn

String resourceShareInvitationArn

The Amazon Resoure Name (ARN) of the invitation that you want to accept.

clientToken

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.

Class com.amazonaws.services.ram.model.AcceptResourceShareInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShareInvitation

ResourceShareInvitation resourceShareInvitation

An object that contains information about the specified invitation.

clientToken

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.

Class com.amazonaws.services.ram.model.AssociateResourceSharePermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share to which you want to add or replace permissions.

permissionArn

String permissionArn

Specifies the Amazon Resoure 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.

replace

Boolean replace

Specifies whether the specified permission should replace or add to the existing permission associated with the resource share. Use true to replace the current permissions. Use false to add the permission to the current 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.

clientToken

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.

permissionVersion

Integer permissionVersion

Specifies the version of the RAM permission to associate with the resource share. If you don't specify this parameter, the operation uses the version designated as the default. You can use the ListPermissionVersions operation to discover the available versions of a permission.

Class com.amazonaws.services.ram.model.AssociateResourceSharePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

returnValue

Boolean returnValue

A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

clientToken

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.

Class com.amazonaws.services.ram.model.AssociateResourceShareRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add principals or resources to.

resourceArns

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.

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 Resoure 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.

clientToken

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.

Class com.amazonaws.services.ram.model.AssociateResourceShareResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShareAssociations

List<E> resourceShareAssociations

An array of objects that contain information about the associations.

clientToken

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.

Class com.amazonaws.services.ram.model.AWSRAMException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.CreateResourceShareRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

Specifies the name of the resource share.

resourceArns

List<E> resourceArns

Specifies a list of one or more ARNs of the resources to associate with the resource share.

principals

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 Resoure 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.

tags

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.

allowExternalPrincipals

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.

clientToken

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.

permissionArns

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.

Class com.amazonaws.services.ram.model.CreateResourceShareResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShare

ResourceShare resourceShare

An object with information about the new resource share.

clientToken

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.

Class com.amazonaws.services.ram.model.DeleteResourceShareRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share to delete.

clientToken

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.

Class com.amazonaws.services.ram.model.DeleteResourceShareResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

returnValue

Boolean returnValue

A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

clientToken

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.

Class com.amazonaws.services.ram.model.DisassociateResourceSharePermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

The Amazon Resoure Name (ARN) of the resource share from which you want to disassociate a permission.

permissionArn

String permissionArn

The Amazon Resoure Name (ARN) of the permission to disassociate from the resource share. Changes to permissions take effect immediately.

clientToken

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.

Class com.amazonaws.services.ram.model.DisassociateResourceSharePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

returnValue

Boolean returnValue

A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

clientToken

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.

Class com.amazonaws.services.ram.model.DisassociateResourceShareRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies Amazon Resoure Name (ARN) of the resource share that you want to remove resources from.

resourceArns

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 outside of the Amazon Web Services account that created the resources.

principals

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 Resoure 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.

clientToken

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.

Class com.amazonaws.services.ram.model.DisassociateResourceShareResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShareAssociations

List<E> resourceShareAssociations

An array of objects that contain information about the updated associations for this resource share.

clientToken

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.

Class com.amazonaws.services.ram.model.EnableSharingWithAwsOrganizationRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ram.model.EnableSharingWithAwsOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

returnValue

Boolean returnValue

A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

Class com.amazonaws.services.ram.model.GetPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

permissionArn

String permissionArn

Specifies the Amazon Resoure 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.

permissionVersion

Integer permissionVersion

Specifies identifier for the version of the RAM permission to retrieve. If you don't specify this parameter, the operation retrieves the default version.

Class com.amazonaws.services.ram.model.GetPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

permission

ResourceSharePermissionDetail permission

An object that contains information about the permission.

Class com.amazonaws.services.ram.model.GetResourcePoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArns

List<E> resourceArns

Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

principal

String principal

Specifies the principal.

nextToken

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.

maxResults

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.

Class com.amazonaws.services.ram.model.GetResourcePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

policies

List<E> policies

An array of resource policy documents in JSON format.

nextToken

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.

Class com.amazonaws.services.ram.model.GetResourceShareAssociationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationType

String associationType

Specifies whether you want to retrieve the associations that involve a specified resource or principal.

• PRINCIPAL – list the principals that are associated with the specified resource share.

• RESOURCE – list the resources that are associated with the specified resource share.

resourceShareArns

List<E> resourceShareArns

Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.

resourceArn

String resourceArn

Specifies the Amazon Resoure Name (ARN) of the resource whose resource shares you want to retrieve.

You cannot specify this parameter if the association type is PRINCIPAL.

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 Resoure Name (ARN) of an individual IAM user or role.

You cannot specify this parameter if the association type is RESOURCE.

associationStatus

String associationStatus

Specifies that you want to retrieve only associations with this status.

nextToken

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.

maxResults

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.

Class com.amazonaws.services.ram.model.GetResourceShareAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShareAssociations

List<E> resourceShareAssociations

An array of objects that contain the details about the associations.

nextToken

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.

Class com.amazonaws.services.ram.model.GetResourceShareInvitationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareInvitationArns

List<E> resourceShareInvitationArns

Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

resourceShareArns

List<E> resourceShareArns

Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

nextToken

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.

maxResults

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.

Class com.amazonaws.services.ram.model.GetResourceShareInvitationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShareInvitations

List<E> resourceShareInvitations

An array of objects that contain the details about the invitations.

nextToken

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.

Class com.amazonaws.services.ram.model.GetResourceSharesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArns

List<E> resourceShareArns

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

resourceShareStatus

String resourceShareStatus

Specifies that you want to retrieve details of only those resource shares that have this status.

resourceOwner

String resourceOwner

Specifies that you want to retrieve details of only those resource shares that match the following:

• SELF – resources that you are sharing

• OTHER-ACCOUNTS – resources that other accounts share with you

name

String name

Specifies the name of an individual resource share that you want to retrieve details about.

tagFilters

List<E> tagFilters

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

nextToken

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.

maxResults

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.

permissionArn

String permissionArn

Specifies that you want to retrieve details of only those resource shares that use the RAM permission with this Amazon Resoure Name (ARN).

Class com.amazonaws.services.ram.model.GetResourceSharesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShares

List<E> resourceShares

An array of objects that contain the information about the resource shares.

nextToken

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.

Class com.amazonaws.services.ram.model.IdempotentParameterMismatchException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.InvalidClientTokenException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.InvalidMaxResultsException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.InvalidNextTokenException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.InvalidParameterException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.InvalidResourceTypeException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.InvalidStateTransitionException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ListPendingInvitationResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareInvitationArn

String resourceShareInvitationArn

Specifies the Amazon Resoure Name (ARN) of the invitation. You can use GetResourceShareInvitations to find the ARN of the invitation.

nextToken

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.

maxResults

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.

resourceRegionScope

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.

Class com.amazonaws.services.ram.model.ListPendingInvitationResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resources

List<E> resources

An array of objects that contain the information about the resources included the specified resource share.

nextToken

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.

Class com.amazonaws.services.ram.model.ListPermissionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceType

String resourceType

Specifies that you want to list permissions for only the specified resource type. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet. You can use the ListResourceTypes operation to get the specific string required.

nextToken

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.

maxResults

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.

Class com.amazonaws.services.ram.model.ListPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

permissions

List<E> permissions

An array of objects with information about the permissions.

nextToken

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.

Class com.amazonaws.services.ram.model.ListPermissionVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

permissionArn

String permissionArn

Specifies the Amazon Resoure 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.

nextToken

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.

maxResults

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.

Class com.amazonaws.services.ram.model.ListPermissionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

permissions

List<E> permissions

An array of objects that contain details for each of the available versions.

nextToken

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.

Class com.amazonaws.services.ram.model.ListPrincipalsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceOwner

String resourceOwner

Specifies that you want to list information for only resource shares that match the following:

• SELF – resources that you are sharing

• OTHER-ACCOUNTS – resources that other accounts share with you

resourceArn

String resourceArn

Specifies that you want to list principal information for the resource share with the specified Amazon Resoure Name (ARN).

principals

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 Resoure 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.

resourceType

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.

resourceShareArns

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).

nextToken

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.

maxResults

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.

Class com.amazonaws.services.ram.model.ListPrincipalsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

principals

List<E> principals

An array of objects that contain the details about the principals.

nextToken

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.

Class com.amazonaws.services.ram.model.ListResourceSharePermissionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share for which you want to retrieve the associated permissions.

nextToken

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.

maxResults

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.

Class com.amazonaws.services.ram.model.ListResourceSharePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

permissions

List<E> permissions

An array of objects that describe the permissions associated with the resource share.

nextToken

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.

Class com.amazonaws.services.ram.model.ListResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceOwner

String resourceOwner

Specifies that you want to list only the resource shares that match the following:

• SELF – resources that you are sharing

• OTHER-ACCOUNTS – resources that other accounts share with you

principal

String principal

Specifies that you want to list only the resource shares that are associated with the specified principal.

resourceType

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.

resourceArns

List<E> resourceArns

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

resourceShareArns

List<E> resourceShareArns

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

nextToken

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.

maxResults

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.

resourceRegionScope

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.

Class com.amazonaws.services.ram.model.ListResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resources

List<E> resources

An array of objects that contain information about the resources.

nextToken

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.

Class com.amazonaws.services.ram.model.ListResourceTypesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

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.

maxResults

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.

resourceRegionScope

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.

Class com.amazonaws.services.ram.model.ListResourceTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceTypes

List<E> resourceTypes

An array of objects that contain information about the resource types that can be shared using RAM.

nextToken

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.

Class com.amazonaws.services.ram.model.MalformedArnException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.MissingRequiredParameterException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.OperationNotPermittedException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.Principal extends Object implements Serializable

Serialized Fields

id

String id

The ID of the principal.

resourceShareArn

String resourceShareArn

The Amazon Resoure Name (ARN) of a resource share the principal is associated with.

creationTime

Date creationTime

The date and time when the principal was associated with the resource share.

lastUpdatedTime

Date lastUpdatedTime

The date and time when the association was last updated.

external

Boolean external

Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

Class com.amazonaws.services.ram.model.PromoteResourceShareCreatedFromPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share to promote.

Class com.amazonaws.services.ram.model.PromoteResourceShareCreatedFromPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

returnValue

Boolean returnValue

A return value of true indicates that the request succeeded. A value of false indicates that the request failed.

Class com.amazonaws.services.ram.model.RejectResourceShareInvitationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareInvitationArn

String resourceShareInvitationArn

Specifies the Amazon Resoure Name (ARN) of the invitation that you want to reject.

clientToken

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.

Class com.amazonaws.services.ram.model.RejectResourceShareInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShareInvitation

ResourceShareInvitation resourceShareInvitation

An object that contains the details about the rejected invitation.

clientToken

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.

Class com.amazonaws.services.ram.model.Resource extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resoure Name (ARN) of the resource.

type

String type

The resource type. This takes the form of: service-code:resource-code

resourceShareArn

String resourceShareArn

The Amazon Resoure Name (ARN) of the resource share this resource is associated with.

resourceGroupArn

String resourceGroupArn

The Amazon Resoure Name (ARN) of the resource group. This value is available only if the resource is part of a resource group.

status

String status

The current status of the resource.

statusMessage

String statusMessage

A message about the status of the resource.

creationTime

Date creationTime

The date and time when the resource was associated with the resource share.

lastUpdatedTime

Date lastUpdatedTime

The date an time when the association was last updated.

resourceRegionScope

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.

Class com.amazonaws.services.ram.model.ResourceArnNotFoundException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ResourceShare extends Object implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

The Amazon Resoure Name (ARN) of the resource share

name

String name

The name of the resource share.

owningAccountId

String owningAccountId

The ID of the Amazon Web Services account that owns the resource share.

allowExternalPrincipals

Boolean allowExternalPrincipals

Indicates whether principals outside your organization in Organizations can be associated with a resource share.

status

String status

The current status of the resource share.

statusMessage

String statusMessage

A message about the status of the resource share.

tags

List<E> tags

The tag key and value pairs attached to the resource share.

creationTime

Date creationTime

The date and time when the resource share was created.

lastUpdatedTime

Date lastUpdatedTime

The date and time when the resource share was last updated.

featureSet

String featureSet

Indicates how the resource share was created. Possible values include:

• CREATED_FROM_POLICY - Indicates that the resource share was created from an Identity and Access Management (IAM) resource-based permission policy attached to the resource. 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 - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy.

• STANDARD - Indicates that the resource share was created in RAM using the console or APIs. 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.

Class com.amazonaws.services.ram.model.ResourceShareAssociation extends Object implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

The Amazon Resoure Name (ARN) of the resource share.

resourceShareName

String resourceShareName

The name of the resource share.

associatedEntity

String associatedEntity

The associated entity. This can be either of the following:

• For a resource association, this is the Amazon Resoure Name (ARN) of the resource.

• For principal associations, this is one of the following:

  • The ID of an Amazon Web Services account

  • The Amazon Resoure 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

associationType

String associationType

The type of entity included in this association.

status

String status

The current status of the association.

statusMessage

String statusMessage

A message about the status of the association.

creationTime

Date creationTime

The date and time when the association was created.

lastUpdatedTime

Date lastUpdatedTime

The date and time when the association was last updated.

external

Boolean external

Indicates whether the principal belongs to the same organization in Organizations as the Amazon Web Services account that owns the resource share.

Class com.amazonaws.services.ram.model.ResourceShareInvitation extends Object implements Serializable

Serialized Fields

resourceShareInvitationArn

String resourceShareInvitationArn

The Amazon Resoure Name (ARN) of the invitation.

resourceShareName

String resourceShareName

The name of the resource share.

resourceShareArn

String resourceShareArn

The Amazon Resoure Name (ARN) of the resource share

senderAccountId

String senderAccountId

The ID of the Amazon Web Services account that sent the invitation.

receiverAccountId

String receiverAccountId

The ID of the Amazon Web Services account that received the invitation.

invitationTimestamp

Date invitationTimestamp

The date and time when the invitation was sent.

status

String status

The current status of the invitation.

resourceShareAssociations

List<E> resourceShareAssociations

Deprecated.

To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.

receiverArn

String receiverArn

The Amazon Resoure Name (ARN) of the IAM user or role that received the invitation.

Class com.amazonaws.services.ram.model.ResourceShareInvitationAlreadyAcceptedException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ResourceShareInvitationAlreadyRejectedException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ResourceShareInvitationArnNotFoundException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ResourceShareInvitationExpiredException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ResourceShareLimitExceededException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ResourceSharePermissionDetail extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resoure Name (ARN) of this RAM permission.

version

String version

The version of the permission represented in this structure.

defaultVersion

Boolean defaultVersion

Specifies whether the version of the permission represented in this structure is the default version for this permission.

name

String name

The name of this permission.

resourceType

String resourceType

The resource type to which this permission applies.

permission

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.

creationTime

Date creationTime

The date and time when the permission was created.

lastUpdatedTime

Date lastUpdatedTime

The date and time when the permission was last updated.

isResourceTypeDefault

Boolean isResourceTypeDefault

Specifies whether the version of the permission represented in this structure is the default version for all resources of this resource type.

Class com.amazonaws.services.ram.model.ResourceSharePermissionSummary extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resoure Name (ARN) of the permission you want information about.

version

String version

The version of the permission represented in this structure.

defaultVersion

Boolean defaultVersion

Specifies whether the version of the permission represented in this structure is the default version for this permission.

name

String name

The name of this permission.

resourceType

String resourceType

The type of resource to which this permission applies.

status

String status

The current status of the permission.

creationTime

Date creationTime

The date and time when the permission was created.

lastUpdatedTime

Date lastUpdatedTime

The date and time when the permission was last updated.

isResourceTypeDefault

Boolean isResourceTypeDefault

Specifies whether the version of the permission represented in this structure is the default version for all resources of this resource type.

Class com.amazonaws.services.ram.model.ServerInternalException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.ServiceNameAndResourceType extends Object implements Serializable

Serialized Fields

resourceType

String resourceType

The type of the resource.

serviceName

String serviceName

The name of the Amazon Web Services service to which resources of this type belong.

resourceRegionScope

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.

Class com.amazonaws.services.ram.model.ServiceUnavailableException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.Tag extends Object implements Serializable

Serialized Fields

key

String key

The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

value

String value

The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

Class com.amazonaws.services.ram.model.TagFilter extends Object implements Serializable

Serialized Fields

tagKey

String tagKey

The tag key. This must have a valid string value and can't be empty.

tagValues

List<E> tagValues

A list of zero or more tag values. If no values are provided, then the filter matches any tag with the specified key, regardless of its value.

Class com.amazonaws.services.ram.model.TagLimitExceededException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.TagPolicyViolationException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to add tags to.

tags

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.

Class com.amazonaws.services.ram.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.ram.model.ThrottlingException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.UnknownResourceException extends AWSRAMException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ram.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure 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.

tagKeys

List<E> tagKeys

Specifies a list of one or more tag keys that you want to remove.

Class com.amazonaws.services.ram.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.ram.model.UpdateResourceShareRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceShareArn

String resourceShareArn

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

name

String name

If specified, the new name that you want to attach to the resource share.

allowExternalPrincipals

Boolean allowExternalPrincipals

Specifies whether principals outside your organization in Organizations can be associated with a resource share.

clientToken

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.

Class com.amazonaws.services.ram.model.UpdateResourceShareResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

resourceShare

ResourceShare resourceShare

Information about the resource share.

clientToken

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.