@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSRAMClient extends AmazonWebServiceClient implements AWSRAM
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 resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations.
For more information, see the AWS Resource Access Manager User Guide.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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.
|
AssociateResourceSharePermissionResult |
associateResourceSharePermission(AssociateResourceSharePermissionRequest request)
Associates a permission with 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 AWS RAM permission from a resource share.
|
EnableSharingWithAwsOrganizationResult |
enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)
Enables resource sharing within your AWS 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.
|
GetPermissionResult |
getPermission(GetPermissionRequest request)
Gets the contents of an AWS RAM permission in JSON format.
|
GetResourcePoliciesResult |
getResourcePolicies(GetResourcePoliciesRequest request)
Gets the policies for the specified resources that you own and have shared.
|
GetResourceShareAssociationsResult |
getResourceShareAssociations(GetResourceShareAssociationsRequest request)
Gets the resources or principals for the resource shares that you own.
|
GetResourceShareInvitationsResult |
getResourceShareInvitations(GetResourceShareInvitationsRequest request)
Gets the invitations for resource sharing that you've received.
|
GetResourceSharesResult |
getResourceShares(GetResourceSharesRequest request)
Gets the resource shares that you own or the resource shares that are shared with you.
|
ListPendingInvitationResourcesResult |
listPendingInvitationResources(ListPendingInvitationResourcesRequest request)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
|
ListPermissionsResult |
listPermissions(ListPermissionsRequest request)
Lists the AWS RAM permissions.
|
ListPrincipalsResult |
listPrincipals(ListPrincipalsRequest request)
Lists the principals that you have shared resources with or that have shared resources with you.
|
ListResourcesResult |
listResources(ListResourcesRequest request)
Lists the resources that you added to a resource shares or the resources that are shared with you.
|
ListResourceSharePermissionsResult |
listResourceSharePermissions(ListResourceSharePermissionsRequest request)
Lists the AWS RAM permissions that are associated with a resource share.
|
ListResourceTypesResult |
listResourceTypes(ListResourceTypesRequest request)
Lists the shareable resource types supported by AWS RAM.
|
PromoteResourceShareCreatedFromPolicyResult |
promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)
Resource shares that were created by attaching a policy to a resource are visible only to the resource share
owner, and the resource share cannot be modified in AWS RAM.
|
RejectResourceShareInvitationResult |
rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)
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 request)
Adds the specified tags to the specified resource share that you own.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource share that you own.
|
UpdateResourceShareResult |
updateResourceShare(UpdateResourceShareRequest request)
Updates the specified resource share that you own.
|
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
public static AWSRAMClientBuilder builder()
public AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest request)
Accepts an invitation to a resource share from another AWS account.
acceptResourceShareInvitation
in interface AWSRAM
acceptResourceShareInvitationRequest
- 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.InvalidClientTokenException
- A client token is not valid.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.public AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest request)
Associates the specified resource share with the specified principals and resources.
associateResourceShare
in interface AWSRAM
associateResourceShareRequest
- 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.public AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest request)
Associates a permission with a resource share.
associateResourceSharePermission
in interface AWSRAM
associateResourceSharePermissionRequest
- 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
- A 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.public CreateResourceShareResult createResourceShare(CreateResourceShareRequest request)
Creates a resource share.
createResourceShare
in interface AWSRAM
createResourceShareRequest
- 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.TagPolicyViolationException
- The specified tag is a reserved word and cannot be used.ServerInternalException
- The service could not respond to the request due to an internal problem.ServiceUnavailableException
- The service is not available.public DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest request)
Deletes the specified resource share.
deleteResourceShare
in interface AWSRAM
deleteResourceShareRequest
- 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.public DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest request)
Disassociates the specified principals or resources from the specified resource share.
disassociateResourceShare
in interface AWSRAM
disassociateResourceShareRequest
- 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.public DisassociateResourceSharePermissionResult disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request)
Disassociates an AWS RAM permission from a resource share.
disassociateResourceSharePermission
in interface AWSRAM
disassociateResourceSharePermissionRequest
- 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
- A 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.public EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)
Enables resource sharing within your AWS Organization.
The caller must be the master account for the AWS Organization.
enableSharingWithAwsOrganization
in interface AWSRAM
enableSharingWithAwsOrganizationRequest
- 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.public GetPermissionResult getPermission(GetPermissionRequest request)
Gets the contents of an AWS RAM permission in JSON format.
getPermission
in interface AWSRAM
getPermissionRequest
- 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.public GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest request)
Gets the policies for the specified resources that you own and have shared.
getResourcePolicies
in interface AWSRAM
getResourcePoliciesRequest
- 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
- 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.public GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest request)
Gets the resources or principals for the resource shares that you own.
getResourceShareAssociations
in interface AWSRAM
getResourceShareAssociationsRequest
- 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.public GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest request)
Gets the invitations for resource sharing that you've received.
getResourceShareInvitations
in interface AWSRAM
getResourceShareInvitationsRequest
- 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.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.public GetResourceSharesResult getResourceShares(GetResourceSharesRequest request)
Gets the resource shares that you own or the resource shares that are shared with you.
getResourceShares
in interface AWSRAM
getResourceSharesRequest
- 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.public ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest request)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
listPendingInvitationResources
in interface AWSRAM
listPendingInvitationResourcesRequest
- 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 Amazon Resource Name (ARN) for an invitation was not found.MissingRequiredParameterException
- A required input parameter is missing.ResourceShareInvitationAlreadyRejectedException
- The invitation was already rejected.ResourceShareInvitationExpiredException
- The invitation is expired.public ListPermissionsResult listPermissions(ListPermissionsRequest request)
Lists the AWS RAM permissions.
listPermissions
in interface AWSRAM
listPermissionsRequest
- 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.public ListPrincipalsResult listPrincipals(ListPrincipalsRequest request)
Lists the principals that you have shared resources with or that have shared resources with you.
listPrincipals
in interface AWSRAM
listPrincipalsRequest
- 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.public ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest request)
Lists the AWS RAM permissions that are associated with a resource share.
listResourceSharePermissions
in interface AWSRAM
listResourceSharePermissionsRequest
- 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.public ListResourceTypesResult listResourceTypes(ListResourceTypesRequest request)
Lists the shareable resource types supported by AWS RAM.
listResourceTypes
in interface AWSRAM
listResourceTypesRequest
- 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.public ListResourcesResult listResources(ListResourcesRequest request)
Lists the resources that you added to a resource shares or the resources that are shared with you.
listResources
in interface AWSRAM
listResourcesRequest
- 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.public PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.
Use this API action to promote the resource share. When you promote the resource share, it becomes:
Visible to all principals that it is shared with.
Modifiable in AWS RAM.
promoteResourceShareCreatedFromPolicy
in interface AWSRAM
promoteResourceShareCreatedFromPolicyRequest
- MalformedArnException
- The format of an Amazon Resource Name (ARN) is not valid.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.public RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)
Rejects an invitation to a resource share from another AWS account.
rejectResourceShareInvitation
in interface AWSRAM
rejectResourceShareInvitationRequest
- 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.InvalidClientTokenException
- A client token is not valid.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.public TagResourceResult tagResource(TagResourceRequest request)
Adds the specified tags to the specified resource share that you own.
tagResource
in interface AWSRAM
tagResourceRequest
- 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.TagPolicyViolationException
- The specified tag is a reserved word and cannot be used.ServerInternalException
- The service could not respond to the request due to an internal problem.ServiceUnavailableException
- The service is not available.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tags from the specified resource share that you own.
untagResource
in interface AWSRAM
untagResourceRequest
- 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.public UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest request)
Updates the specified resource share that you own.
updateResourceShare
in interface AWSRAM
updateResourceShareRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AWSRAM
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSRAM
shutdown
in class AmazonWebServiceClient