com.amazonaws.services.ram

Class AWSRAMClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ram.AWSRAMClient

All Implemented Interfaces:

AWSRAM

Direct Known Subclasses:

AWSRAMAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSRAMClient
extends AmazonWebServiceClient
implements AWSRAM

Client for accessing RAM. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ram.AWSRAM

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AcceptResourceShareInvitationResult	acceptResourceShareInvitation(AcceptResourceShareInvitationRequest request) Accepts an invitation to a resource share from another Amazon Web Services account.
AssociateResourceShareResult	associateResourceShare(AssociateResourceShareRequest request) Adds the specified list of principals and list of resources to a resource share.
AssociateResourceSharePermissionResult	associateResourceSharePermission(AssociateResourceSharePermissionRequest request) Adds or replaces the RAM permission for a resource type included in a resource share.
static AWSRAMClientBuilder	builder()
CreateResourceShareResult	createResourceShare(CreateResourceShareRequest request) Creates a resource share.
DeleteResourceShareResult	deleteResourceShare(DeleteResourceShareRequest request) Deletes the specified resource share.
DisassociateResourceShareResult	disassociateResourceShare(DisassociateResourceShareRequest request) Disassociates the specified principals or resources from the specified resource share.
DisassociateResourceSharePermissionResult	disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request) Disassociates an RAM permission from a resource share.
EnableSharingWithAwsOrganizationResult	enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request) 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 request) Gets the contents of an RAM permission in JSON format.
GetResourcePoliciesResult	getResourcePolicies(GetResourcePoliciesRequest request) Retrieves the resource policies for the specified resources that you own and have shared.
GetResourceShareAssociationsResult	getResourceShareAssociations(GetResourceShareAssociationsRequest request) Retrieves the resource and principal associations for resource shares that you own.
GetResourceShareInvitationsResult	getResourceShareInvitations(GetResourceShareInvitationsRequest request) Retrieves details about invitations that you have received for resource shares.
GetResourceSharesResult	getResourceShares(GetResourceSharesRequest request) Retrieves details about the resource shares that you own or that are shared with you.
ListPendingInvitationResourcesResult	listPendingInvitationResources(ListPendingInvitationResourcesRequest request) Lists the resources in a resource share that is shared with you but for which the invitation is still PENDING.
ListPermissionsResult	listPermissions(ListPermissionsRequest request) Retrieves a list of available RAM permissions that you can use for the supported resource types.
ListPermissionVersionsResult	listPermissionVersions(ListPermissionVersionsRequest request) Lists the available versions of the specified RAM permission.
ListPrincipalsResult	listPrincipals(ListPrincipalsRequest request) Lists the principals that you are sharing resources with or that are sharing resources with you.
ListResourcesResult	listResources(ListResourcesRequest request) Lists the resources that you added to a resource share or the resources that are shared with you.
ListResourceSharePermissionsResult	listResourceSharePermissions(ListResourceSharePermissionsRequest request) Lists the RAM permissions that are associated with a resource share.
ListResourceTypesResult	listResourceTypes(ListResourceTypesRequest request) Lists the resource types that can be shared by RAM.
PromoteResourceShareCreatedFromPolicyResult	promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request) When you attach a resource-based permission policy to a resource, it automatically creates a resource share.
RejectResourceShareInvitationResult	rejectResourceShareInvitation(RejectResourceShareInvitationRequest request) 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 request) Adds the specified tag keys and values to the specified resource share.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tag key and value pairs from the specified resource share.
UpdateResourceShareResult	updateResourceShare(UpdateResourceShareRequest request) Modifies some of the properties of the specified resource share.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSRAMClientBuilder builder()

acceptResourceShareInvitation

public AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest request)

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.

Specified by:

acceptResourceShareInvitation in interface AWSRAM

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

public AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest request)

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.

Specified by:

associateResourceShare in interface AWSRAM

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

public AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest request)

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.

Specified by:

associateResourceSharePermission in interface AWSRAM

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

public CreateResourceShareResult createResourceShare(CreateResourceShareRequest request)

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.

Specified by:

createResourceShare in interface AWSRAM

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

public DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest request)

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.

Specified by:

deleteResourceShare in interface AWSRAM

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

public DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest request)

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

Specified by:

disassociateResourceShare in interface AWSRAM

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

public DisassociateResourceSharePermissionResult disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request)

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.

Specified by:

disassociateResourceSharePermission in interface AWSRAM

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

public EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)

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.

Specified by:

enableSharingWithAwsOrganization in interface AWSRAM

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

public GetPermissionResult getPermission(GetPermissionRequest request)

Gets the contents of an RAM permission in JSON format.

Specified by:

getPermission in interface AWSRAM

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

public GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest request)

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

Specified by:

getResourcePolicies in interface AWSRAM

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

public GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest request)

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

Specified by:

getResourceShareAssociations in interface AWSRAM

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

public GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest request)

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

Specified by:

getResourceShareInvitations in interface AWSRAM

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

public GetResourceSharesResult getResourceShares(GetResourceSharesRequest request)

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

Specified by:

getResourceShares in interface AWSRAM

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

public ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest request)

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.

Specified by:

listPendingInvitationResources in interface AWSRAM

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

public ListPermissionVersionsResult listPermissionVersions(ListPermissionVersionsRequest request)

Lists the available versions of the specified RAM permission.

Specified by:

listPermissionVersions in interface AWSRAM

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

public ListPermissionsResult listPermissions(ListPermissionsRequest request)

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

Specified by:

listPermissions in interface AWSRAM

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

public ListPrincipalsResult listPrincipals(ListPrincipalsRequest request)

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

Specified by:

listPrincipals in interface AWSRAM

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

public ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest request)

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

Specified by:

listResourceSharePermissions in interface AWSRAM

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

public ListResourceTypesResult listResourceTypes(ListResourceTypesRequest request)

Lists the resource types that can be shared by RAM.

Specified by:

listResourceTypes in interface AWSRAM

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

public ListResourcesResult listResources(ListResourcesRequest request)

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

Specified by:

listResources in interface AWSRAM

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

public PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)

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.

Specified by:

promoteResourceShareCreatedFromPolicy in interface AWSRAM

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

public RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)

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

Specified by:

rejectResourceShareInvitation in interface AWSRAM

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

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AWSRAM

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

public UntagResourceResult untagResource(UntagResourceRequest request)

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

Specified by:

untagResource in interface AWSRAM

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

public UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest request)

Modifies some of the properties of the specified resource share.

Specified by:

updateResourceShare in interface AWSRAM

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSRAM

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSRAM

Overrides:

shutdown in class AmazonWebServiceClient