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.

Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resource. The following principals are supported:

• The ID of an AWS account

• The Amazon Resource Name (ARN) of an OU from AWS Organizations

• The Amazon Resource Name (ARN) of an organization from AWS Organizations

If you specify an AWS account that doesn't exist in the same organization as the account that owns the resource share, the owner of the specified account receives an invitation to accept the resource share. After the owner accepts the invitation, they can access the resources in the resource share. An administrator of the specified account can use IAM policies to restrict access resources in the resource share.

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 AWS account.
AssociateResourceShareResult	associateResourceShare(AssociateResourceShareRequest request) Associates the specified resource share with the specified principals and resources.
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.
EnableSharingWithAwsOrganizationResult	enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request) Enables resource sharing within your organization.
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.
GetResourcePoliciesResult	getResourcePolicies(GetResourcePoliciesRequest request) Gets the policies for the specifies resources.
GetResourceShareAssociationsResult	getResourceShareAssociations(GetResourceShareAssociationsRequest request) Gets the associations for the specified resource share.
GetResourceShareInvitationsResult	getResourceShareInvitations(GetResourceShareInvitationsRequest request) Gets the specified invitations for resource sharing.
GetResourceSharesResult	getResourceShares(GetResourceSharesRequest request) Gets the specified resource shares or all of your resource shares.
ListPrincipalsResult	listPrincipals(ListPrincipalsRequest request) Lists the principals with access to the specified resource.
ListResourcesResult	listResources(ListResourcesRequest request) Lists the resources that the specified principal can access.
RejectResourceShareInvitationResult	rejectResourceShareInvitation(RejectResourceShareInvitationRequest request) Rejects an invitation to a resource share from another AWS account.
TagResourceResult	tagResource(TagResourceRequest request) Adds the specified tags to the specified resource share.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified resource share.
UpdateResourceShareResult	updateResourceShare(UpdateResourceShareRequest request) Updates 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, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

shutdown

Method Detail

builder

public static AWSRAMClientBuilder builder()

acceptResourceShareInvitation

public AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest request)

Accepts an invitation to a resource share from another AWS account.

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 Amazon Resource Name (ARN) for an invitation was not found.

ResourceShareInvitationAlreadyAcceptedException - The invitation was already accepted.

ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.

ResourceShareInvitationExpiredException - The invitation is expired.

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

associateResourceShare

public AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest request)

Associates the specified resource share with the specified principals and resources.

Specified by:

associateResourceShare in interface AWSRAM

Parameters:

associateResourceShareRequest -

Returns:

Result of the AssociateResourceShare operation returned by the service.

Throws:

IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

UnknownResourceException - A specified resource was not found.

InvalidStateTransitionException - The requested state transition is not valid.

ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.

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

InvalidStateTransitionException - The requested state transition is not valid.

InvalidClientTokenException - A 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

createResourceShare

public CreateResourceShareResult createResourceShare(CreateResourceShareRequest request)

Creates a resource share.

Specified by:

createResourceShare in interface AWSRAM

Parameters:

createResourceShareRequest -

Returns:

Result of the CreateResourceShare operation returned by the service.

Throws:

IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

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 - A client token is not valid.

InvalidParameterException - A parameter is not valid.

OperationNotPermittedException - The requested operation is not permitted.

ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.

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.

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 - A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

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 - A 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 - A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.

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

InvalidStateTransitionException - The requested state transition is not valid.

InvalidClientTokenException - A 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

enableSharingWithAwsOrganization

public EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)

Enables resource sharing within your organization.

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

getResourcePolicies

public GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest request)

Gets the policies for the specifies resources.

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.

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)

Gets the associations for the specified resource share.

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)

Gets the specified invitations for resource sharing.

Specified by:

getResourceShareInvitations in interface AWSRAM

Parameters:

getResourceShareInvitationsRequest -

Returns:

Result of the GetResourceShareInvitations operation returned by the service.

Throws:

ResourceShareInvitationArnNotFoundException - The 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.

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)

Gets the specified resource shares or all of your resource shares.

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

listPrincipals

public ListPrincipalsResult listPrincipals(ListPrincipalsRequest request)

Lists the principals with access to the specified resource.

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

listResources

public ListResourcesResult listResources(ListResourcesRequest request)

Lists the resources that the specified principal can access.

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

rejectResourceShareInvitation

public RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)

Rejects an invitation to a resource share from another AWS 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 Amazon Resource Name (ARN) for an invitation was not found.

ResourceShareInvitationAlreadyAcceptedException - The invitation was already accepted.

ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.

ResourceShareInvitationExpiredException - The invitation is expired.

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

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds the specified tags to the specified 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.

TagLimitExceededException - The requested tags exceed the limit for your account.

ResourceArnNotFoundException - An 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

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags 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)

Updates the specified resource share.

Specified by:

updateResourceShare in interface AWSRAM

Parameters:

updateResourceShareRequest -

Returns:

Result of the UpdateResourceShare operation returned by the service.

Throws:

IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

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