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.

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

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 AWS account.
AssociateResourceShareResult	associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest) Associates the specified resource share with the specified principals and resources.
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.
EnableSharingWithAwsOrganizationResult	enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) 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 getResourcePoliciesRequest) Gets the policies for the specifies resources.
GetResourceShareAssociationsResult	getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) Gets the associations for the specified resource share.
GetResourceShareInvitationsResult	getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) Gets the specified invitations for resource sharing.
GetResourceSharesResult	getResourceShares(GetResourceSharesRequest getResourceSharesRequest) Gets the specified resource shares or all of your resource shares.
ListPrincipalsResult	listPrincipals(ListPrincipalsRequest listPrincipalsRequest) Lists the principals with access to the specified resource.
ListResourcesResult	listResources(ListResourcesRequest listResourcesRequest) Lists the resources that the specified principal can access.
RejectResourceShareInvitationResult	rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest) Rejects an invitation to a resource share from another AWS account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource share.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource share.
UpdateResourceShareResult	updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest) Updates 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 AWS account.

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

AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest)

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

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

CreateResourceShareResult createResourceShare(CreateResourceShareRequest createResourceShareRequest)

Creates a resource share.

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

DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest)

Deletes the specified resource share.

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

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

EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest)

Enables resource sharing within your organization.

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

GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)

Gets the policies for the specifies resources.

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

GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest)

Gets the associations for the specified resource share.

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)

Gets the specified invitations for resource sharing.

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

GetResourceSharesResult getResourceShares(GetResourceSharesRequest getResourceSharesRequest)

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

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

ListPrincipalsResult listPrincipals(ListPrincipalsRequest listPrincipalsRequest)

Lists the principals with access to the specified resource.

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

ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)

Lists the resources that the specified principal can access.

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

RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest)

Rejects an invitation to a resource share from another AWS 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 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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Updates the specified resource share.

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

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.