com.amazonaws.services.ram

Interface AWSRAM

All Known Subinterfaces:

AWSRAMAsync

All Known Implementing Classes:

AbstractAWSRAM, AbstractAWSRAMAsync, AWSRAMAsyncClient, AWSRAMClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRAM

Interface for accessing RAM.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSRAM instead.

This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources across Amazon Web Services accounts. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts. If you use Organizations to manage your accounts, then you share your resources with your organization or organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles an users.

To learn more about RAM, see the following resources:

• Resource Access Manager product page

• Resource Access Manager User Guide

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptResourceShareInvitationResult	acceptResourceShareInvitation(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest) Accepts an invitation to a resource share from another Amazon Web Services account.
AssociateResourceShareResult	associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest) Adds the specified list of principals and list of resources to a resource share.
AssociateResourceSharePermissionResult	associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest) Adds or replaces the RAM permission for a resource type included in a resource share.
CreateResourceShareResult	createResourceShare(CreateResourceShareRequest createResourceShareRequest) Creates a resource share.
DeleteResourceShareResult	deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest) Deletes the specified resource share.
DisassociateResourceShareResult	disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest) Disassociates the specified principals or resources from the specified resource share.
DisassociateResourceSharePermissionResult	disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest) Disassociates an RAM permission from a resource share.
EnableSharingWithAwsOrganizationResult	enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) Enables resource sharing within your organization in Organizations.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetPermissionResult	getPermission(GetPermissionRequest getPermissionRequest) Gets the contents of an RAM permission in JSON format.
GetResourcePoliciesResult	getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest) Retrieves the resource policies for the specified resources that you own and have shared.
GetResourceShareAssociationsResult	getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) Retrieves the resource and principal associations for resource shares that you own.
GetResourceShareInvitationsResult	getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) Retrieves details about invitations that you have received for resource shares.
GetResourceSharesResult	getResourceShares(GetResourceSharesRequest getResourceSharesRequest) Retrieves details about the resource shares that you own or that are shared with you.
ListPendingInvitationResourcesResult	listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING.
ListPermissionsResult	listPermissions(ListPermissionsRequest listPermissionsRequest) Retrieves a list of available RAM permissions that you can use for the supported resource types.
ListPermissionVersionsResult	listPermissionVersions(ListPermissionVersionsRequest listPermissionVersionsRequest) Lists the available versions of the specified RAM permission.
ListPrincipalsResult	listPrincipals(ListPrincipalsRequest listPrincipalsRequest) Lists the principals that you are sharing resources with or that are sharing resources with you.
ListResourcesResult	listResources(ListResourcesRequest listResourcesRequest) Lists the resources that you added to a resource share or the resources that are shared with you.
ListResourceSharePermissionsResult	listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) Lists the RAM permissions that are associated with a resource share.
ListResourceTypesResult	listResourceTypes(ListResourceTypesRequest listResourceTypesRequest) Lists the resource types that can be shared by RAM.
PromoteResourceShareCreatedFromPolicyResult	promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest) When you attach a resource-based permission policy to a resource, it automatically creates a resource share.
RejectResourceShareInvitationResult	rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest) Rejects an invitation to a resource share from another Amazon Web Services account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tag keys and values to the specified resource share.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tag key and value pairs from the specified resource share.
UpdateResourceShareResult	updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest) Modifies some of the properties of the specified resource share.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

acceptResourceShareInvitation

AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest)

Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.

Parameters:

acceptResourceShareInvitationRequest -

Returns:

Result of the AcceptResourceShareInvitation operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ResourceShareInvitationArnNotFoundException - The specified Amazon Resource Name (ARN) for an invitation was not found.

ResourceShareInvitationAlreadyAcceptedException - The specified invitation was already accepted.

ResourceShareInvitationAlreadyRejectedException - The specified invitation was already rejected.

ResourceShareInvitationExpiredException - The specified invitation is expired.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

InvalidClientTokenException - The client token is not valid.

IdempotentParameterMismatchException - The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

See Also:

AWS API Documentation

associateResourceShare

AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest)

Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.

Parameters:

associateResourceShareRequest -

Returns:

Result of the AssociateResourceShare operation returned by the service.

Throws:

IdempotentParameterMismatchException - The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

UnknownResourceException - A specified resource was not found.

InvalidStateTransitionException - The requested state transition is not valid.

ResourceShareLimitExceededException - This request would exceed the limit for resource shares for your account.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidStateTransitionException - The requested state transition is not valid.

InvalidClientTokenException - The client token is not valid.

InvalidParameterException - A parameter is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

UnknownResourceException - A specified resource was not found.

ThrottlingException - You exceeded the rate at which you are allowed to perform this operation. Please try again later.

See Also:

AWS API Documentation

associateResourceSharePermission

AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest)

Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.

Parameters:

associateResourceSharePermissionRequest -

Returns:

Result of the AssociateResourceSharePermission operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

InvalidParameterException - A parameter is not valid.

InvalidClientTokenException - The client token is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

OperationNotPermittedException - The requested operation is not permitted.

See Also:

AWS API Documentation

createResourceShare

CreateResourceShareResult createResourceShare(CreateResourceShareRequest createResourceShareRequest)

Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.

Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.

Parameters:

createResourceShareRequest -

Returns:

Result of the CreateResourceShare operation returned by the service.

Throws:

IdempotentParameterMismatchException - The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

InvalidStateTransitionException - The requested state transition is not valid.

UnknownResourceException - A specified resource was not found.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidClientTokenException - The client token is not valid.

InvalidParameterException - A parameter is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ResourceShareLimitExceededException - This request would exceed the limit for resource shares for your account.

TagPolicyViolationException - The specified tag key is a reserved word and can't be used.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

deleteResourceShare

DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest)

Deletes the specified resource share. This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources outside of the Amazon Web Services account that created them.

Parameters:

deleteResourceShareRequest -

Returns:

Result of the DeleteResourceShare operation returned by the service.

Throws:

OperationNotPermittedException - The requested operation is not permitted.

IdempotentParameterMismatchException - The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

InvalidStateTransitionException - The requested state transition is not valid.

UnknownResourceException - A specified resource was not found.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidClientTokenException - The client token is not valid.

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

disassociateResourceShare

DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest)

Disassociates the specified principals or resources from the specified resource share.

Parameters:

disassociateResourceShareRequest -

Returns:

Result of the DisassociateResourceShare operation returned by the service.

Throws:

IdempotentParameterMismatchException - The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

ResourceShareLimitExceededException - This request would exceed the limit for resource shares for your account.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidStateTransitionException - The requested state transition is not valid.

InvalidClientTokenException - The client token is not valid.

InvalidParameterException - A parameter is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

UnknownResourceException - A specified resource was not found.

See Also:

AWS API Documentation

disassociateResourceSharePermission

DisassociateResourceSharePermissionResult disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest)

Disassociates an RAM permission from a resource share. Permission changes take effect immediately. You can remove a RAM permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.

Parameters:

disassociateResourceSharePermissionRequest -

Returns:

Result of the DisassociateResourceSharePermission operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

InvalidParameterException - A parameter is not valid.

InvalidClientTokenException - The client token is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

OperationNotPermittedException - The requested operation is not permitted.

InvalidStateTransitionException - The requested state transition is not valid.

See Also:

AWS API Documentation

enableSharingWithAwsOrganization

EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest)

Enables resource sharing within your organization in Organizations. Calling this operation enables RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in an organization by specifying the organization's ID, or all of the accounts in an organizational unit (OU) by specifying the OU's ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM users and roles.

You must call this operation from an IAM user or role in the organization's management account.

Parameters:

enableSharingWithAwsOrganizationRequest -

Returns:

Result of the EnableSharingWithAwsOrganization operation returned by the service.

Throws:

OperationNotPermittedException - The requested operation is not permitted.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

getPermission

GetPermissionResult getPermission(GetPermissionRequest getPermissionRequest)

Gets the contents of an RAM permission in JSON format.

Parameters:

getPermissionRequest -

Returns:

Result of the GetPermission operation returned by the service.

Throws:

InvalidParameterException - A parameter is not valid.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

OperationNotPermittedException - The requested operation is not permitted.

See Also:

AWS API Documentation

getResourcePolicies

GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)

Retrieves the resource policies for the specified resources that you own and have shared.

Parameters:

getResourcePoliciesRequest -

Returns:

Result of the GetResourcePolicies operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

ResourceArnNotFoundException - The specified Amazon Resource Name (ARN) was not found.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

getResourceShareAssociations

GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest)

Retrieves the resource and principal associations for resource shares that you own.

Parameters:

getResourceShareAssociationsRequest -

Returns:

Result of the GetResourceShareAssociations operation returned by the service.

Throws:

UnknownResourceException - A specified resource was not found.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

getResourceShareInvitations

GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest)

Retrieves details about invitations that you have received for resource shares.

Parameters:

getResourceShareInvitationsRequest -

Returns:

Result of the GetResourceShareInvitations operation returned by the service.

Throws:

ResourceShareInvitationArnNotFoundException - The specified Amazon Resource Name (ARN) for an invitation was not found.

InvalidMaxResultsException - The specified value for MaxResults is not valid.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

getResourceShares

GetResourceSharesResult getResourceShares(GetResourceSharesRequest getResourceSharesRequest)

Retrieves details about the resource shares that you own or that are shared with you.

Parameters:

getResourceSharesRequest -

Returns:

Result of the GetResourceShares operation returned by the service.

Throws:

UnknownResourceException - A specified resource was not found.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

listPendingInvitationResources

ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest)

Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.

Parameters:

listPendingInvitationResourcesRequest -

Returns:

Result of the ListPendingInvitationResources operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

ResourceShareInvitationArnNotFoundException - The specified Amazon Resource Name (ARN) for an invitation was not found.

MissingRequiredParameterException - A required input parameter is missing.

ResourceShareInvitationAlreadyRejectedException - The specified invitation was already rejected.

ResourceShareInvitationExpiredException - The specified invitation is expired.

See Also:

AWS API Documentation

listPermissionVersions

ListPermissionVersionsResult listPermissionVersions(ListPermissionVersionsRequest listPermissionVersionsRequest)

Lists the available versions of the specified RAM permission.

Parameters:

listPermissionVersionsRequest -

Returns:

Result of the ListPermissionVersions operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

InvalidNextTokenException - The specified value for NextToken is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

OperationNotPermittedException - The requested operation is not permitted.

InvalidParameterException - A parameter is not valid.

See Also:

AWS API Documentation

listPermissions

ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest)

Retrieves a list of available RAM permissions that you can use for the supported resource types.

Parameters:

listPermissionsRequest -

Returns:

Result of the ListPermissions operation returned by the service.

Throws:

InvalidParameterException - A parameter is not valid.

InvalidNextTokenException - The specified value for NextToken is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

OperationNotPermittedException - The requested operation is not permitted.

See Also:

AWS API Documentation

listPrincipals

ListPrincipalsResult listPrincipals(ListPrincipalsRequest listPrincipalsRequest)

Lists the principals that you are sharing resources with or that are sharing resources with you.

Parameters:

listPrincipalsRequest -

Returns:

Result of the ListPrincipals operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

listResourceSharePermissions

ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest)

Lists the RAM permissions that are associated with a resource share.

Parameters:

listResourceSharePermissionsRequest -

Returns:

Result of the ListResourceSharePermissions operation returned by the service.

Throws:

InvalidParameterException - A parameter is not valid.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

InvalidNextTokenException - The specified value for NextToken is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

OperationNotPermittedException - The requested operation is not permitted.

See Also:

AWS API Documentation

listResourceTypes

ListResourceTypesResult listResourceTypes(ListResourceTypesRequest listResourceTypesRequest)

Lists the resource types that can be shared by RAM.

Parameters:

listResourceTypesRequest -

Returns:

Result of the ListResourceTypes operation returned by the service.

Throws:

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

listResources

ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)

Lists the resources that you added to a resource share or the resources that are shared with you.

Parameters:

listResourcesRequest -

Returns:

Result of the ListResources operation returned by the service.

Throws:

InvalidResourceTypeException - The specified resource type is not valid.

UnknownResourceException - A specified resource was not found.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidNextTokenException - The specified value for NextToken is not valid.

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

promoteResourceShareCreatedFromPolicy

PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest)

When you attach a resource-based permission policy to a resource, it automatically creates a resource share. However, resource shares created this way are visible only to the resource share owner, and the resource share can't be modified in RAM.

You can use this operation to promote the resource share to a full RAM resource share. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.

Parameters:

promoteResourceShareCreatedFromPolicyRequest -

Returns:

Result of the PromoteResourceShareCreatedFromPolicy operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

ResourceShareLimitExceededException - This request would exceed the limit for resource shares for your account.

OperationNotPermittedException - The requested operation is not permitted.

InvalidParameterException - A parameter is not valid.

MissingRequiredParameterException - A required input parameter is missing.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

UnknownResourceException - A specified resource was not found.

See Also:

AWS API Documentation

rejectResourceShareInvitation

RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest)

Rejects an invitation to a resource share from another Amazon Web Services account.

Parameters:

rejectResourceShareInvitationRequest -

Returns:

Result of the RejectResourceShareInvitation operation returned by the service.

Throws:

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ResourceShareInvitationArnNotFoundException - The specified Amazon Resource Name (ARN) for an invitation was not found.

ResourceShareInvitationAlreadyAcceptedException - The specified invitation was already accepted.

ResourceShareInvitationAlreadyRejectedException - The specified invitation was already rejected.

ResourceShareInvitationExpiredException - The specified invitation is expired.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

InvalidClientTokenException - The client token is not valid.

IdempotentParameterMismatchException - The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds the specified tag keys and values to the specified resource share. The tags are attached only to the resource share, not to the resources that are in the resource share.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidParameterException - A parameter is not valid.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

UnknownResourceException - A specified resource was not found.

TagLimitExceededException - This request would exceed the limit for tags for your account.

ResourceArnNotFoundException - The specified Amazon Resource Name (ARN) was not found.

TagPolicyViolationException - The specified tag key is a reserved word and can't be used.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tag key and value pairs from the specified resource share.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidParameterException - A parameter is not valid.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

updateResourceShare

UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest)

Modifies some of the properties of the specified resource share.

Parameters:

updateResourceShareRequest -

Returns:

Result of the UpdateResourceShare operation returned by the service.

Throws:

IdempotentParameterMismatchException - The client token input parameter was matched one used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.

MissingRequiredParameterException - A required input parameter is missing.

UnknownResourceException - A specified resource was not found.

MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.

InvalidClientTokenException - The client token is not valid.

InvalidParameterException - A parameter is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ServerInternalException - The service could not respond to the request due to an internal problem.

ServiceUnavailableException - The service is not available.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.