@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSRAM
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 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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
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.
|
AssociateResourceSharePermissionResult |
associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest)
Associates a permission with a resource share.
|
CreateResourceShareResult |
createResourceShare(CreateResourceShareRequest createResourceShareRequest)
Creates a resource share.
|
DeleteResourceShareResult |
deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest)
Deletes the specified resource share.
|
DisassociateResourceShareResult |
disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest)
Disassociates the specified principals or resources from the specified resource share.
|
DisassociateResourceSharePermissionResult |
disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest)
Disassociates an AWS RAM permission from a resource share.
|
EnableSharingWithAwsOrganizationResult |
enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest)
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 getPermissionRequest)
Gets the contents of an AWS RAM permission in JSON format.
|
GetResourcePoliciesResult |
getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Gets the policies for the specified resources that you own and have shared.
|
GetResourceShareAssociationsResult |
getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest)
Gets the resources or principals for the resource shares that you own.
|
GetResourceShareInvitationsResult |
getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest)
Gets the invitations for resource sharing that you've received.
|
GetResourceSharesResult |
getResourceShares(GetResourceSharesRequest getResourceSharesRequest)
Gets the resource shares that you own or the resource shares that are shared with you.
|
ListPendingInvitationResourcesResult |
listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
|
ListPermissionsResult |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Lists the AWS RAM permissions.
|
ListPrincipalsResult |
listPrincipals(ListPrincipalsRequest listPrincipalsRequest)
Lists the principals that you have shared resources with or that have shared resources with you.
|
ListResourcesResult |
listResources(ListResourcesRequest listResourcesRequest)
Lists the resources that you added to a resource shares or the resources that are shared with you.
|
ListResourceSharePermissionsResult |
listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest)
Lists the AWS RAM permissions that are associated with a resource share.
|
ListResourceTypesResult |
listResourceTypes(ListResourceTypesRequest listResourceTypesRequest)
Lists the shareable resource types supported by AWS RAM.
|
PromoteResourceShareCreatedFromPolicyResult |
promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest)
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 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 that you own.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource share that you own.
|
UpdateResourceShareResult |
updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest)
Updates the specified resource share that you own.
|
static final String ENDPOINT_PREFIX
AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest)
Accepts an invitation to a resource share from another AWS account.
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.AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest)
Associates the specified resource share with the specified principals and resources.
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.AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest)
Associates a permission with a resource share.
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.CreateResourceShareResult createResourceShare(CreateResourceShareRequest createResourceShareRequest)
Creates a resource share.
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.DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest)
Deletes the specified resource share.
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.DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest)
Disassociates the specified principals or resources from the specified resource share.
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.DisassociateResourceSharePermissionResult disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest)
Disassociates an AWS RAM permission from a resource share.
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.EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest)
Enables resource sharing within your AWS Organization.
The caller must be the master account for the AWS Organization.
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.GetPermissionResult getPermission(GetPermissionRequest getPermissionRequest)
Gets the contents of an AWS RAM permission in JSON format.
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.GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Gets the policies for the specified resources that you own and have shared.
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.GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest)
Gets the resources or principals for the resource shares that you own.
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.GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest)
Gets the invitations for resource sharing that you've received.
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.GetResourceSharesResult getResourceShares(GetResourceSharesRequest getResourceSharesRequest)
Gets the resource shares that you own or the resource shares that are shared with you.
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.ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
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.ListPermissionsResult listPermissions(ListPermissionsRequest listPermissionsRequest)
Lists the AWS RAM permissions.
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.ListPrincipalsResult listPrincipals(ListPrincipalsRequest listPrincipalsRequest)
Lists the principals that you have shared resources with or that have shared resources with you.
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.ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest)
Lists the AWS RAM permissions that are associated with a resource share.
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.ListResourceTypesResult listResourceTypes(ListResourceTypesRequest listResourceTypesRequest)
Lists the shareable resource types supported by AWS RAM.
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.ListResourcesResult listResources(ListResourcesRequest listResourcesRequest)
Lists the resources that you added to a resource shares or the resources that are shared with you.
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.PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest)
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.
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.RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest)
Rejects an invitation to a resource share from another AWS account.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource share that you own.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource share that you own.
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.UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest)
Updates the specified resource share that you own.
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.void shutdown()
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 a request.
request
- The originally executed request.