@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSRAM extends Object implements AWSRAM
AWSRAM. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.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.
|
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.
|
public AcceptResourceShareInvitationResult acceptResourceShareInvitation(AcceptResourceShareInvitationRequest request)
AWSRAMAccepts 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 AWSRAMpublic AssociateResourceShareResult associateResourceShare(AssociateResourceShareRequest request)
AWSRAMAdds 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 AWSRAMpublic AssociateResourceSharePermissionResult associateResourceSharePermission(AssociateResourceSharePermissionRequest request)
AWSRAMAdds 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 AWSRAMpublic CreatePermissionResult createPermission(CreatePermissionRequest request)
AWSRAMCreates 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 AWSRAMpublic CreatePermissionVersionResult createPermissionVersion(CreatePermissionVersionRequest request)
AWSRAMCreates 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 AWSRAMpublic CreateResourceShareResult createResourceShare(CreateResourceShareRequest request)
AWSRAMCreates 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 AWSRAMpublic DeletePermissionResult deletePermission(DeletePermissionRequest request)
AWSRAMDeletes 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 AWSRAMpublic DeletePermissionVersionResult deletePermissionVersion(DeletePermissionVersionRequest request)
AWSRAMDeletes 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 AWSRAMpublic DeleteResourceShareResult deleteResourceShare(DeleteResourceShareRequest request)
AWSRAMDeletes 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 AWSRAMpublic DisassociateResourceShareResult disassociateResourceShare(DisassociateResourceShareRequest request)
AWSRAMRemoves the specified principals or resources from participating in the specified resource share.
disassociateResourceShare in interface AWSRAMpublic DisassociateResourceSharePermissionResult disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest request)
AWSRAMRemoves 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 AWSRAMpublic EnableSharingWithAwsOrganizationResult enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest request)
AWSRAM
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 AWSRAMpublic GetPermissionResult getPermission(GetPermissionRequest request)
AWSRAMRetrieves the contents of a managed permission in JSON format.
getPermission in interface AWSRAMpublic GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest request)
AWSRAMRetrieves the resource policies for the specified resources that you own and have shared.
getResourcePolicies in interface AWSRAMpublic GetResourceShareAssociationsResult getResourceShareAssociations(GetResourceShareAssociationsRequest request)
AWSRAMRetrieves the lists of resources and principals that associated for resource shares that you own.
getResourceShareAssociations in interface AWSRAMpublic GetResourceShareInvitationsResult getResourceShareInvitations(GetResourceShareInvitationsRequest request)
AWSRAMRetrieves details about invitations that you have received for resource shares.
getResourceShareInvitations in interface AWSRAMpublic GetResourceSharesResult getResourceShares(GetResourceSharesRequest request)
AWSRAMRetrieves details about the resource shares that you own or that are shared with you.
getResourceShares in interface AWSRAMpublic ListPendingInvitationResourcesResult listPendingInvitationResources(ListPendingInvitationResourcesRequest request)
AWSRAM
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 AWSRAMpublic ListPermissionAssociationsResult listPermissionAssociations(ListPermissionAssociationsRequest request)
AWSRAMLists 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 AWSRAMpublic ListPermissionVersionsResult listPermissionVersions(ListPermissionVersionsRequest request)
AWSRAMLists the available versions of the specified RAM permission.
listPermissionVersions in interface AWSRAMpublic ListPermissionsResult listPermissions(ListPermissionsRequest request)
AWSRAMRetrieves a list of available RAM permissions that you can use for the supported resource types.
listPermissions in interface AWSRAMpublic ListPrincipalsResult listPrincipals(ListPrincipalsRequest request)
AWSRAMLists the principals that you are sharing resources with or that are sharing resources with you.
listPrincipals in interface AWSRAMpublic ListReplacePermissionAssociationsWorkResult listReplacePermissionAssociationsWork(ListReplacePermissionAssociationsWorkRequest request)
AWSRAMRetrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
listReplacePermissionAssociationsWork in interface AWSRAMpublic ListResourceSharePermissionsResult listResourceSharePermissions(ListResourceSharePermissionsRequest request)
AWSRAMLists the RAM permissions that are associated with a resource share.
listResourceSharePermissions in interface AWSRAMpublic ListResourceTypesResult listResourceTypes(ListResourceTypesRequest request)
AWSRAMLists the resource types that can be shared by RAM.
listResourceTypes in interface AWSRAMpublic ListResourcesResult listResources(ListResourcesRequest request)
AWSRAMLists the resources that you added to a resource share or the resources that are shared with you.
listResources in interface AWSRAMpublic PromotePermissionCreatedFromPolicyResult promotePermissionCreatedFromPolicy(PromotePermissionCreatedFromPolicyRequest request)
AWSRAM
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 AWSRAMpublic PromoteResourceShareCreatedFromPolicyResult promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest request)
AWSRAM
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 AWSRAMpublic RejectResourceShareInvitationResult rejectResourceShareInvitation(RejectResourceShareInvitationRequest request)
AWSRAMRejects an invitation to a resource share from another Amazon Web Services account.
rejectResourceShareInvitation in interface AWSRAMpublic ReplacePermissionAssociationsResult replacePermissionAssociations(ReplacePermissionAssociationsRequest request)
AWSRAMUpdates 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 AWSRAMpublic SetDefaultPermissionVersionResult setDefaultPermissionVersion(SetDefaultPermissionVersionRequest request)
AWSRAMDesignates 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 AWSRAMpublic TagResourceResult tagResource(TagResourceRequest request)
AWSRAMAdds 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 AWSRAMpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSRAMRemoves the specified tag key and value pairs from the specified resource share or managed permission.
untagResource in interface AWSRAMpublic UpdateResourceShareResult updateResourceShare(UpdateResourceShareRequest request)
AWSRAMModifies some of the properties of the specified resource share.
updateResourceShare in interface AWSRAMpublic void shutdown()
AWSRAMpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSRAMResponse 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.
getCachedResponseMetadata in interface AWSRAMrequest - The originally executed request.