@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSRAMClient extends AmazonWebServiceClient implements AWSRAM
This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources to other Amazon Web Services accounts. If you use Organizations to manage your accounts, then you can share your resources with your entire organization or to organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles and users.
To learn more about RAM, see the following resources:
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 Amazon Web Services account.
|
AssociateResourceShareResult |
associateResourceShare(AssociateResourceShareRequest request)
Adds the specified list of principals and list of resources to a resource share.
|
AssociateResourceSharePermissionResult |
associateResourceSharePermission(AssociateResourceSharePermissionRequest request)
Adds or replaces the RAM permission for a resource type included in a resource share.
|
static AWSRAMClientBuilder |
builder() |
CreatePermissionResult |
createPermission(CreatePermissionRequest request)
Creates a customer managed permission for a specified resource type that you can attach to resource shares.
|
CreatePermissionVersionResult |
createPermissionVersion(CreatePermissionVersionRequest request)
Creates a new version of the specified customer managed permission.
|
CreateResourceShareResult |
createResourceShare(CreateResourceShareRequest request)
Creates a resource share.
|
DeletePermissionResult |
deletePermission(DeletePermissionRequest request)
Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this
operation.
|
DeletePermissionVersionResult |
deletePermissionVersion(DeletePermissionVersionRequest request)
Deletes one version of a customer managed permission.
|
DeleteResourceShareResult |
deleteResourceShare(DeleteResourceShareRequest request)
Deletes the specified resource share.
|
DisassociateResourceShareResult |
disassociateResourceShare(DisassociateResourceShareRequest request)
Removes the specified principals or resources from participating in the specified resource share.
|
DisassociateResourceSharePermissionResult |
disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request)
Removes a managed permission from a resource share.
|
EnableSharingWithAwsOrganizationResult |
enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)
Enables resource sharing within your organization in Organizations.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetPermissionResult |
getPermission(GetPermissionRequest request)
Retrieves the contents of a managed permission in JSON format.
|
GetResourcePoliciesResult |
getResourcePolicies(GetResourcePoliciesRequest request)
Retrieves the resource policies for the specified resources that you own and have shared.
|
GetResourceShareAssociationsResult |
getResourceShareAssociations(GetResourceShareAssociationsRequest request)
Retrieves the lists of resources and principals that associated for resource shares that you own.
|
GetResourceShareInvitationsResult |
getResourceShareInvitations(GetResourceShareInvitationsRequest request)
Retrieves details about invitations that you have received for resource shares.
|
GetResourceSharesResult |
getResourceShares(GetResourceSharesRequest request)
Retrieves details about the resource shares that you own or that are shared with you.
|
ListPendingInvitationResourcesResult |
listPendingInvitationResources(ListPendingInvitationResourcesRequest request)
Lists the resources in a resource share that is shared with you but for which the invitation is still
PENDING . |
ListPermissionAssociationsResult |
listPermissionAssociations(ListPermissionAssociationsRequest request)
Lists information about the managed permission and its associations to any resource shares that use this managed
permission.
|
ListPermissionsResult |
listPermissions(ListPermissionsRequest request)
Retrieves a list of available RAM permissions that you can use for the supported resource types.
|
ListPermissionVersionsResult |
listPermissionVersions(ListPermissionVersionsRequest request)
Lists the available versions of the specified RAM permission.
|
ListPrincipalsResult |
listPrincipals(ListPrincipalsRequest request)
Lists the principals that you are sharing resources with or that are sharing resources with you.
|
ListReplacePermissionAssociationsWorkResult |
listReplacePermissionAssociationsWork(ListReplacePermissionAssociationsWorkRequest request)
Retrieves the current status of the asynchronous tasks performed by RAM when you perform the
ReplacePermissionAssociationsWork operation.
|
ListResourcesResult |
listResources(ListResourcesRequest request)
Lists the resources that you added to a resource share or the resources that are shared with you.
|
ListResourceSharePermissionsResult |
listResourceSharePermissions(ListResourceSharePermissionsRequest request)
Lists the RAM permissions that are associated with a resource share.
|
ListResourceTypesResult |
listResourceTypes(ListResourceTypesRequest request)
Lists the resource types that can be shared by RAM.
|
PromotePermissionCreatedFromPolicyResult |
promotePermissionCreatedFromPolicy(PromotePermissionCreatedFromPolicyRequest request)
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet =CREATED_FROM_POLICY with a managed permission that has the same IAM
permissions as the original resource-based policy. |
PromoteResourceShareCreatedFromPolicyResult |
promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet =CREATED_FROM_POLICY with a managed permission that has the same IAM
permissions as the original resource-based policy. |
RejectResourceShareInvitationResult |
rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)
Rejects an invitation to a resource share from another Amazon Web Services account.
|
ReplacePermissionAssociationsResult |
replacePermissionAssociations(ReplacePermissionAssociationsRequest request)
Updates all resource shares that use a managed permission to a different managed permission.
|
SetDefaultPermissionVersionResult |
setDefaultPermissionVersion(SetDefaultPermissionVersionRequest request)
Designates the specified version number as the default version for the specified customer managed permission.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds the specified tag keys and values to a resource share or managed permission.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes the specified tag key and value pairs from the specified resource share or managed permission.
|
UpdateResourceShareResult |
updateResourceShare(UpdateResourceShareRequest request)
Modifies some of the properties of the specified resource share.
|
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 Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.
acceptResourceShareInvitation
in interface AWSRAM
acceptResourceShareInvitationRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ResourceShareInvitationArnNotFoundException
- The operation failed because the specified Amazon Resource Name
(ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException
- The operation failed because the specified invitation was already accepted.ResourceShareInvitationAlreadyRejectedException
- The operation failed because the specified invitation was already rejected.ResourceShareInvitationExpiredException
- The operation failed because the specified invitation is past its expiration date and time.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.public AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest request)
Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.
associateResourceShare
in interface AWSRAM
associateResourceShareRequest
- IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidStateTransitionException
- The operation failed because the requested operation isn't valid for the resource share in its current
state.ResourceShareLimitExceededException
- The operation failed because it would exceed the limit for resource shares for your account. To view the
limits for your Amazon Web Services account, see the RAM page in the Service
Quotas console.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidStateTransitionException
- The operation failed because the requested operation isn't valid for the resource share in its current
state.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.UnknownResourceException
- The operation failed because a specified resource couldn't be found.ThrottlingException
- The operation failed because it exceeded the rate at which you are allowed to perform this operation.
Please try again later.public AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest request)
Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.
associateResourceSharePermission
in interface AWSRAM
associateResourceSharePermissionRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.public CreatePermissionResult createPermission(CreatePermissionRequest request)
Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.
createPermission
in interface AWSRAM
createPermissionRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.InvalidPolicyException
- The operation failed because a policy you specified isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.PermissionAlreadyExistsException
- The operation failed because a permission with the specified name already exists in the requested Amazon
Web Services Region. Choose a different name.MalformedPolicyTemplateException
- The operation failed because the policy template that you provided isn't valid.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.PermissionLimitExceededException
- The operation failed because it would exceed the maximum number of permissions you can create in each
Amazon Web Services Region. To view the limits for your Amazon Web Services account, see the RAM page in the Service
Quotas console.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.public CreatePermissionVersionResult createPermissionVersion(CreatePermissionVersionRequest request)
Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them.
If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.
createPermissionVersion
in interface AWSRAM
createPermissionVersionRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.InvalidPolicyException
- The operation failed because a policy you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.UnknownResourceException
- The operation failed because a specified resource couldn't be found.MalformedPolicyTemplateException
- The operation failed because the policy template that you provided isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.PermissionVersionsLimitExceededException
- The operation failed because it would exceed the limit for the number of versions you can have for a
permission. To view the limits for your Amazon Web Services account, see the RAM page in the Service
Quotas console.public CreateResourceShareResult createResourceShare(CreateResourceShareRequest request)
Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.
Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.
createResourceShare
in interface AWSRAM
createResourceShareRequest
- IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.InvalidStateTransitionException
- The operation failed because the requested operation isn't valid for the resource share in its current
state.UnknownResourceException
- The operation failed because a specified resource couldn't be found.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ResourceShareLimitExceededException
- The operation failed because it would exceed the limit for resource shares for your account. To view the
limits for your Amazon Web Services account, see the RAM page in the Service
Quotas console.TagPolicyViolationException
- The operation failed because the specified tag key is a reserved word and can't be used.TagLimitExceededException
- The operation failed because it would exceed the limit for tags for your Amazon Web Services account.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public DeletePermissionResult deletePermission(DeletePermissionRequest request)
Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.
deletePermission
in interface AWSRAM
deletePermissionRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.public DeletePermissionVersionResult deletePermissionVersion(DeletePermissionVersionRequest request)
Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.
If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.
deletePermissionVersion
in interface AWSRAM
deletePermissionVersionRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.public DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest request)
Deletes the specified resource share.
This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this resource share.
deleteResourceShare
in interface AWSRAM
deleteResourceShareRequest
- OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.InvalidStateTransitionException
- The operation failed because the requested operation isn't valid for the resource share in its current
state.UnknownResourceException
- The operation failed because a specified resource couldn't be found.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest request)
Removes the specified principals or resources from participating in the specified resource share.
disassociateResourceShare
in interface AWSRAM
disassociateResourceShareRequest
- IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.ResourceShareLimitExceededException
- The operation failed because it would exceed the limit for resource shares for your account. To view the
limits for your Amazon Web Services account, see the RAM page in the Service
Quotas console.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidStateTransitionException
- The operation failed because the requested operation isn't valid for the resource share in its current
state.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.UnknownResourceException
- The operation failed because a specified resource couldn't be found.public DisassociateResourceSharePermissionResult disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request)
Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.
disassociateResourceSharePermission
in interface AWSRAM
disassociateResourceSharePermissionRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.InvalidStateTransitionException
- The operation failed because the requested operation isn't valid for the resource share in its current
state.public EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)
Enables resource sharing within your organization in Organizations. This operation creates a service-linked role
called AWSServiceRoleForResourceAccessManager
that has the IAM managed policy named
AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the
organization and its structure. This lets you share resources with all of the accounts in the calling account's
organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by
specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon
Web Services accounts, or for supported resource types, IAM roles and users.
You must call this operation from an IAM role or user in the organization's management account.
enableSharingWithAwsOrganization
in interface AWSRAM
enableSharingWithAwsOrganizationRequest
- OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public GetPermissionResult getPermission(GetPermissionRequest request)
Retrieves the contents of a managed permission in JSON format.
getPermission
in interface AWSRAM
getPermissionRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.public GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest request)
Retrieves the resource policies for the specified resources that you own and have shared.
getResourcePolicies
in interface AWSRAM
getResourcePoliciesRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ResourceArnNotFoundException
- The operation failed because the specified Amazon Resource Name
(ARN) was not found.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest request)
Retrieves the lists of resources and principals that associated for resource shares that you own.
getResourceShareAssociations
in interface AWSRAM
getResourceShareAssociationsRequest
- UnknownResourceException
- The operation failed because a specified resource couldn't be found.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest request)
Retrieves details about invitations that you have received for resource shares.
getResourceShareInvitations
in interface AWSRAM
getResourceShareInvitationsRequest
- ResourceShareInvitationArnNotFoundException
- The operation failed because the specified Amazon Resource Name
(ARN) for an invitation was not found.InvalidMaxResultsException
- The operation failed because the specified value for MaxResults
isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public GetResourceSharesResult getResourceShares(GetResourceSharesRequest request)
Retrieves details about the resource shares that you own or that are shared with you.
getResourceShares
in interface AWSRAM
getResourceSharesRequest
- UnknownResourceException
- The operation failed because a specified resource couldn't be found.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest request)
Lists the resources in a resource share that is shared with you but for which the invitation is still
PENDING
. That means that you haven't accepted or rejected the invitation and the invitation hasn't
expired.
listPendingInvitationResources
in interface AWSRAM
listPendingInvitationResourcesRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.ResourceShareInvitationArnNotFoundException
- The operation failed because the specified Amazon Resource Name
(ARN) for an invitation was not found.MissingRequiredParameterException
- The operation failed because a required input parameter is missing.ResourceShareInvitationAlreadyRejectedException
- The operation failed because the specified invitation was already rejected.ResourceShareInvitationExpiredException
- The operation failed because the specified invitation is past its expiration date and time.public ListPermissionAssociationsResult listPermissionAssociations(ListPermissionAssociationsRequest request)
Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission.
listPermissionAssociations
in interface AWSRAM
listPermissionAssociationsRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public ListPermissionVersionsResult listPermissionVersions(ListPermissionVersionsRequest request)
Lists the available versions of the specified RAM permission.
listPermissionVersions
in interface AWSRAM
listPermissionVersionsRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.public ListPermissionsResult listPermissions(ListPermissionsRequest request)
Retrieves a list of available RAM permissions that you can use for the supported resource types.
listPermissions
in interface AWSRAM
listPermissionsRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.public ListPrincipalsResult listPrincipals(ListPrincipalsRequest request)
Lists the principals that you are sharing resources with or that are sharing resources with you.
listPrincipals
in interface AWSRAM
listPrincipalsRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public ListReplacePermissionAssociationsWorkResult listReplacePermissionAssociationsWork(ListReplacePermissionAssociationsWorkRequest request)
Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
listReplacePermissionAssociationsWork
in interface AWSRAM
listReplacePermissionAssociationsWorkRequest
- ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.public ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest request)
Lists the RAM permissions that are associated with a resource share.
listResourceSharePermissions
in interface AWSRAM
listResourceSharePermissionsRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.public ListResourceTypesResult listResourceTypes(ListResourceTypesRequest request)
Lists the resource types that can be shared by RAM.
listResourceTypes
in interface AWSRAM
listResourceTypesRequest
- InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public ListResourcesResult listResources(ListResourcesRequest request)
Lists the resources that you added to a resource share or the resources that are shared with you.
listResources
in interface AWSRAM
listResourcesRequest
- InvalidResourceTypeException
- The operation failed because the specified resource type isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidNextTokenException
- The operation failed because the specified value for NextToken
isn't valid. You must specify
a value you received in the NextToken
response of a previous call to this operation.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public PromotePermissionCreatedFromPolicyResult promotePermissionCreatedFromPolicy(PromotePermissionCreatedFromPolicyRequest request)
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM
permissions as the original resource-based policy. However, this type of managed permission is visible to only
the resource share owner, and the associated resource share can't be modified by using RAM.
This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares.
Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.
The original CREATED_FROM_POLICY
policy isn't deleted, and resource shares using that original
policy aren't automatically updated.
You can't modify a CREATED_FROM_POLICY
resource share so you can't associate the new customer
managed permission by using ReplacePermsissionAssociations
. However, if you use
PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable
customer managed permission to the newly promoted STANDARD
resource share.
After you promote a resource share, if the original CREATED_FROM_POLICY
managed permission has no
other associations to A resource share, then RAM automatically deletes it.
promotePermissionCreatedFromPolicy
in interface AWSRAM
promotePermissionCreatedFromPolicyRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MissingRequiredParameterException
- The operation failed because a required input parameter is missing.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.UnknownResourceException
- The operation failed because a specified resource couldn't be found.public PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM
permissions as the original resource-based policy. However, this type of managed permission is visible to only
the resource share owner, and the associated resource share can't be modified by using RAM.
This operation promotes the resource share to a STANDARD
resource share that is fully manageable in
RAM. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to
all of the principals you shared it with.
Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that
you have an appropriate customer managed permission that can be associated with this resource share after its is
promoted. If this operation can't find a managed permission that exactly matches the existing
CREATED_FROM_POLICY
permission, then this operation fails.
promoteResourceShareCreatedFromPolicy
in interface AWSRAM
promoteResourceShareCreatedFromPolicyRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.ResourceShareLimitExceededException
- The operation failed because it would exceed the limit for resource shares for your account. To view the
limits for your Amazon Web Services account, see the RAM page in the Service
Quotas console.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MissingRequiredParameterException
- The operation failed because a required input parameter is missing.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidStateTransitionException
- The operation failed because the requested operation isn't valid for the resource share in its current
state.UnmatchedPolicyPermissionException
- There isn't an existing managed permission defined in RAM that has the same IAM permissions as the
resource-based policy attached to the resource. You should first run
PromotePermissionCreatedFromPolicy to create that managed permission.public RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)
Rejects an invitation to a resource share from another Amazon Web Services account.
rejectResourceShareInvitation
in interface AWSRAM
rejectResourceShareInvitationRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ResourceShareInvitationArnNotFoundException
- The operation failed because the specified Amazon Resource Name
(ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException
- The operation failed because the specified invitation was already accepted.ResourceShareInvitationAlreadyRejectedException
- The operation failed because the specified invitation was already rejected.ResourceShareInvitationExpiredException
- The operation failed because the specified invitation is past its expiration date and time.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.public ReplacePermissionAssociationsResult replacePermissionAssociations(ReplacePermissionAssociationsRequest request)
Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.
You can use this operation to update all of your resource shares to use the current default version of the
permission by specifying the same value for the fromPermissionArn
and toPermissionArn
parameters.
You can use the optional fromPermissionVersion
parameter to update only those resources that use a
specified version of the managed permission to the new managed permission.
To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.
replacePermissionAssociations
in interface AWSRAM
replacePermissionAssociationsRequest
- MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.public SetDefaultPermissionVersionResult setDefaultPermissionVersion(SetDefaultPermissionVersionRequest request)
Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.
setDefaultPermissionVersion
in interface AWSRAM
setDefaultPermissionVersionRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.public TagResourceResult tagResource(TagResourceRequest request)
Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share.
The tags on a managed permission are the same for all versions of the managed permission.
tagResource
in interface AWSRAM
tagResourceRequest
- InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.UnknownResourceException
- The operation failed because a specified resource couldn't be found.TagLimitExceededException
- The operation failed because it would exceed the limit for tags for your Amazon Web Services account.ResourceArnNotFoundException
- The operation failed because the specified Amazon Resource Name
(ARN) was not found.TagPolicyViolationException
- The operation failed because the specified tag key is a reserved word and can't be used.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes the specified tag key and value pairs from the specified resource share or managed permission.
untagResource
in interface AWSRAM
untagResourceRequest
- UnknownResourceException
- The operation failed because a specified resource couldn't be found.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.public UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest request)
Modifies some of the properties of the specified resource share.
updateResourceShare
in interface AWSRAM
updateResourceShareRequest
- IdempotentParameterMismatchException
- The operation failed because the client token input parameter matched one that was used with a previous
call to the operation, but at least one of the other input parameters is different from the previous
call.MissingRequiredParameterException
- The operation failed because a required input parameter is missing.UnknownResourceException
- The operation failed because a specified resource couldn't be found.MalformedArnException
- The operation failed because the specified Amazon Resource Name
(ARN) has a format that isn't valid.InvalidClientTokenException
- The operation failed because the specified client token isn't valid.InvalidParameterException
- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException
- The operation failed because the requested operation isn't permitted.ServerInternalException
- The operation failed because the service could not respond to the request due to an internal problem. Try
again later.ServiceUnavailableException
- The operation failed because the service isn't available. Try again later.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