@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSRAMAsync extends AWSRAM
AsyncHandler can be used to receive notification when
an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSRAMAsync instead.
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 across Amazon Web Services accounts. If you have multiple Amazon Web Services accounts, you can use RAM to share those resources with other accounts. If you use Organizations to manage your accounts, then you share your resources with your organization or organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles an users.
To learn more about RAM, see the following resources:
ENDPOINT_PREFIXacceptResourceShareInvitation, associateResourceShare, associateResourceSharePermission, createResourceShare, deleteResourceShare, disassociateResourceShare, disassociateResourceSharePermission, enableSharingWithAwsOrganization, getCachedResponseMetadata, getPermission, getResourcePolicies, getResourceShareAssociations, getResourceShareInvitations, getResourceShares, listPendingInvitationResources, listPermissions, listPermissionVersions, listPrincipals, listResources, listResourceSharePermissions, listResourceTypes, promoteResourceShareCreatedFromPolicy, rejectResourceShareInvitation, shutdown, tagResource, untagResource, updateResourceShareFuture<AcceptResourceShareInvitationResult> acceptResourceShareInvitationAsync(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest)
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.
acceptResourceShareInvitationRequest - Future<AcceptResourceShareInvitationResult> acceptResourceShareInvitationAsync(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest, AsyncHandler<AcceptResourceShareInvitationRequest,AcceptResourceShareInvitationResult> asyncHandler)
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.
acceptResourceShareInvitationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateResourceShareResult> associateResourceShareAsync(AssociateResourceShareRequest associateResourceShareRequest)
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.
associateResourceShareRequest - Future<AssociateResourceShareResult> associateResourceShareAsync(AssociateResourceShareRequest associateResourceShareRequest, AsyncHandler<AssociateResourceShareRequest,AssociateResourceShareResult> asyncHandler)
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.
associateResourceShareRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateResourceSharePermissionResult> associateResourceSharePermissionAsync(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest)
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.
associateResourceSharePermissionRequest - Future<AssociateResourceSharePermissionResult> associateResourceSharePermissionAsync(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest, AsyncHandler<AssociateResourceSharePermissionRequest,AssociateResourceSharePermissionResult> asyncHandler)
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.
associateResourceSharePermissionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateResourceShareResult> createResourceShareAsync(CreateResourceShareRequest createResourceShareRequest)
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.
createResourceShareRequest - Future<CreateResourceShareResult> createResourceShareAsync(CreateResourceShareRequest createResourceShareRequest, AsyncHandler<CreateResourceShareRequest,CreateResourceShareResult> asyncHandler)
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.
createResourceShareRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteResourceShareResult> deleteResourceShareAsync(DeleteResourceShareRequest deleteResourceShareRequest)
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 outside of the Amazon Web Services account that created them.
deleteResourceShareRequest - Future<DeleteResourceShareResult> deleteResourceShareAsync(DeleteResourceShareRequest deleteResourceShareRequest, AsyncHandler<DeleteResourceShareRequest,DeleteResourceShareResult> asyncHandler)
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 outside of the Amazon Web Services account that created them.
deleteResourceShareRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateResourceShareResult> disassociateResourceShareAsync(DisassociateResourceShareRequest disassociateResourceShareRequest)
Disassociates the specified principals or resources from the specified resource share.
disassociateResourceShareRequest - Future<DisassociateResourceShareResult> disassociateResourceShareAsync(DisassociateResourceShareRequest disassociateResourceShareRequest, AsyncHandler<DisassociateResourceShareRequest,DisassociateResourceShareResult> asyncHandler)
Disassociates the specified principals or resources from the specified resource share.
disassociateResourceShareRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateResourceSharePermissionResult> disassociateResourceSharePermissionAsync(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest)
Disassociates an RAM permission from a resource share. Permission changes take effect immediately. You can remove a RAM permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.
disassociateResourceSharePermissionRequest - Future<DisassociateResourceSharePermissionResult> disassociateResourceSharePermissionAsync(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest, AsyncHandler<DisassociateResourceSharePermissionRequest,DisassociateResourceSharePermissionResult> asyncHandler)
Disassociates an RAM permission from a resource share. Permission changes take effect immediately. You can remove a RAM permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.
disassociateResourceSharePermissionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EnableSharingWithAwsOrganizationResult> enableSharingWithAwsOrganizationAsync(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest)
Enables resource sharing within your organization in Organizations. Calling this operation enables RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in an organization by specifying the organization's ID, or all of the accounts in an organizational unit (OU) by specifying the OU's ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM users and roles.
You must call this operation from an IAM user or role in the organization's management account.
enableSharingWithAwsOrganizationRequest - Future<EnableSharingWithAwsOrganizationResult> enableSharingWithAwsOrganizationAsync(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest, AsyncHandler<EnableSharingWithAwsOrganizationRequest,EnableSharingWithAwsOrganizationResult> asyncHandler)
Enables resource sharing within your organization in Organizations. Calling this operation enables RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in an organization by specifying the organization's ID, or all of the accounts in an organizational unit (OU) by specifying the OU's ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM users and roles.
You must call this operation from an IAM user or role in the organization's management account.
enableSharingWithAwsOrganizationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetPermissionResult> getPermissionAsync(GetPermissionRequest getPermissionRequest)
Gets the contents of an RAM permission in JSON format.
getPermissionRequest - Future<GetPermissionResult> getPermissionAsync(GetPermissionRequest getPermissionRequest, AsyncHandler<GetPermissionRequest,GetPermissionResult> asyncHandler)
Gets the contents of an RAM permission in JSON format.
getPermissionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResourcePoliciesResult> getResourcePoliciesAsync(GetResourcePoliciesRequest getResourcePoliciesRequest)
Retrieves the resource policies for the specified resources that you own and have shared.
getResourcePoliciesRequest - Future<GetResourcePoliciesResult> getResourcePoliciesAsync(GetResourcePoliciesRequest getResourcePoliciesRequest, AsyncHandler<GetResourcePoliciesRequest,GetResourcePoliciesResult> asyncHandler)
Retrieves the resource policies for the specified resources that you own and have shared.
getResourcePoliciesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResourceShareAssociationsResult> getResourceShareAssociationsAsync(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest)
Retrieves the resource and principal associations for resource shares that you own.
getResourceShareAssociationsRequest - Future<GetResourceShareAssociationsResult> getResourceShareAssociationsAsync(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest, AsyncHandler<GetResourceShareAssociationsRequest,GetResourceShareAssociationsResult> asyncHandler)
Retrieves the resource and principal associations for resource shares that you own.
getResourceShareAssociationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResourceShareInvitationsResult> getResourceShareInvitationsAsync(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest)
Retrieves details about invitations that you have received for resource shares.
getResourceShareInvitationsRequest - Future<GetResourceShareInvitationsResult> getResourceShareInvitationsAsync(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest, AsyncHandler<GetResourceShareInvitationsRequest,GetResourceShareInvitationsResult> asyncHandler)
Retrieves details about invitations that you have received for resource shares.
getResourceShareInvitationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetResourceSharesResult> getResourceSharesAsync(GetResourceSharesRequest getResourceSharesRequest)
Retrieves details about the resource shares that you own or that are shared with you.
getResourceSharesRequest - Future<GetResourceSharesResult> getResourceSharesAsync(GetResourceSharesRequest getResourceSharesRequest, AsyncHandler<GetResourceSharesRequest,GetResourceSharesResult> asyncHandler)
Retrieves details about the resource shares that you own or that are shared with you.
getResourceSharesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPendingInvitationResourcesResult> listPendingInvitationResourcesAsync(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest)
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.
listPendingInvitationResourcesRequest - Future<ListPendingInvitationResourcesResult> listPendingInvitationResourcesAsync(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest, AsyncHandler<ListPendingInvitationResourcesRequest,ListPendingInvitationResourcesResult> asyncHandler)
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.
listPendingInvitationResourcesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPermissionVersionsResult> listPermissionVersionsAsync(ListPermissionVersionsRequest listPermissionVersionsRequest)
Lists the available versions of the specified RAM permission.
listPermissionVersionsRequest - Future<ListPermissionVersionsResult> listPermissionVersionsAsync(ListPermissionVersionsRequest listPermissionVersionsRequest, AsyncHandler<ListPermissionVersionsRequest,ListPermissionVersionsResult> asyncHandler)
Lists the available versions of the specified RAM permission.
listPermissionVersionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest listPermissionsRequest)
Retrieves a list of available RAM permissions that you can use for the supported resource types.
listPermissionsRequest - Future<ListPermissionsResult> listPermissionsAsync(ListPermissionsRequest listPermissionsRequest, AsyncHandler<ListPermissionsRequest,ListPermissionsResult> asyncHandler)
Retrieves a list of available RAM permissions that you can use for the supported resource types.
listPermissionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListPrincipalsResult> listPrincipalsAsync(ListPrincipalsRequest listPrincipalsRequest)
Lists the principals that you are sharing resources with or that are sharing resources with you.
listPrincipalsRequest - Future<ListPrincipalsResult> listPrincipalsAsync(ListPrincipalsRequest listPrincipalsRequest, AsyncHandler<ListPrincipalsRequest,ListPrincipalsResult> asyncHandler)
Lists the principals that you are sharing resources with or that are sharing resources with you.
listPrincipalsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceSharePermissionsResult> listResourceSharePermissionsAsync(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest)
Lists the RAM permissions that are associated with a resource share.
listResourceSharePermissionsRequest - Future<ListResourceSharePermissionsResult> listResourceSharePermissionsAsync(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest, AsyncHandler<ListResourceSharePermissionsRequest,ListResourceSharePermissionsResult> asyncHandler)
Lists the RAM permissions that are associated with a resource share.
listResourceSharePermissionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourceTypesResult> listResourceTypesAsync(ListResourceTypesRequest listResourceTypesRequest)
Lists the resource types that can be shared by RAM.
listResourceTypesRequest - Future<ListResourceTypesResult> listResourceTypesAsync(ListResourceTypesRequest listResourceTypesRequest, AsyncHandler<ListResourceTypesRequest,ListResourceTypesResult> asyncHandler)
Lists the resource types that can be shared by RAM.
listResourceTypesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest)
Lists the resources that you added to a resource share or the resources that are shared with you.
listResourcesRequest - Future<ListResourcesResult> listResourcesAsync(ListResourcesRequest listResourcesRequest, AsyncHandler<ListResourcesRequest,ListResourcesResult> asyncHandler)
Lists the resources that you added to a resource share or the resources that are shared with you.
listResourcesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PromoteResourceShareCreatedFromPolicyResult> promoteResourceShareCreatedFromPolicyAsync(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest)
When you attach a resource-based permission policy to a resource, it automatically creates a resource share. However, resource shares created this way are visible only to the resource share owner, and the resource share can't be modified in RAM.
You can use this operation to promote the resource share to a full RAM resource share. 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.
promoteResourceShareCreatedFromPolicyRequest - Future<PromoteResourceShareCreatedFromPolicyResult> promoteResourceShareCreatedFromPolicyAsync(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest, AsyncHandler<PromoteResourceShareCreatedFromPolicyRequest,PromoteResourceShareCreatedFromPolicyResult> asyncHandler)
When you attach a resource-based permission policy to a resource, it automatically creates a resource share. However, resource shares created this way are visible only to the resource share owner, and the resource share can't be modified in RAM.
You can use this operation to promote the resource share to a full RAM resource share. 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.
promoteResourceShareCreatedFromPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RejectResourceShareInvitationResult> rejectResourceShareInvitationAsync(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest)
Rejects an invitation to a resource share from another Amazon Web Services account.
rejectResourceShareInvitationRequest - Future<RejectResourceShareInvitationResult> rejectResourceShareInvitationAsync(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest, AsyncHandler<RejectResourceShareInvitationRequest,RejectResourceShareInvitationResult> asyncHandler)
Rejects an invitation to a resource share from another Amazon Web Services account.
rejectResourceShareInvitationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds the specified tag keys and values to the specified resource share. The tags are attached only to the resource share, not to the resources that are in the resource share.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds the specified tag keys and values to the specified resource share. The tags are attached only to the resource share, not to the resources that are in the resource share.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the specified tag key and value pairs from the specified resource share.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the specified tag key and value pairs from the specified resource share.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateResourceShareResult> updateResourceShareAsync(UpdateResourceShareRequest updateResourceShareRequest)
Modifies some of the properties of the specified resource share.
updateResourceShareRequest - Future<UpdateResourceShareResult> updateResourceShareAsync(UpdateResourceShareRequest updateResourceShareRequest, AsyncHandler<UpdateResourceShareRequest,UpdateResourceShareResult> asyncHandler)
Modifies some of the properties of the specified resource share.
updateResourceShareRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.