Interface RamAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The
asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the
SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such
as credentials retrieval and endpoint discovery as part of the async API call.
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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptResourceShareInvitation
(Consumer<AcceptResourceShareInvitationRequest.Builder> acceptResourceShareInvitationRequest) Accepts an invitation to a resource share from another Amazon Web Services account.acceptResourceShareInvitation
(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest) Accepts an invitation to a resource share from another Amazon Web Services account.associateResourceShare
(Consumer<AssociateResourceShareRequest.Builder> associateResourceShareRequest) Adds the specified list of principals and list of resources to a resource share.associateResourceShare
(AssociateResourceShareRequest associateResourceShareRequest) Adds the specified list of principals and list of resources to a resource share.associateResourceSharePermission
(Consumer<AssociateResourceSharePermissionRequest.Builder> associateResourceSharePermissionRequest) Adds or replaces the RAM permission for a resource type included in a resource share.associateResourceSharePermission
(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest) Adds or replaces the RAM permission for a resource type included in a resource share.static RamAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aRamAsyncClient
.static RamAsyncClient
create()
Create aRamAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createPermission
(Consumer<CreatePermissionRequest.Builder> createPermissionRequest) Creates a customer managed permission for a specified resource type that you can attach to resource shares.createPermission
(CreatePermissionRequest createPermissionRequest) Creates a customer managed permission for a specified resource type that you can attach to resource shares.createPermissionVersion
(Consumer<CreatePermissionVersionRequest.Builder> createPermissionVersionRequest) Creates a new version of the specified customer managed permission.createPermissionVersion
(CreatePermissionVersionRequest createPermissionVersionRequest) Creates a new version of the specified customer managed permission.createResourceShare
(Consumer<CreateResourceShareRequest.Builder> createResourceShareRequest) Creates a resource share.createResourceShare
(CreateResourceShareRequest createResourceShareRequest) Creates a resource share.deletePermission
(Consumer<DeletePermissionRequest.Builder> deletePermissionRequest) Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation.deletePermission
(DeletePermissionRequest deletePermissionRequest) Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation.deletePermissionVersion
(Consumer<DeletePermissionVersionRequest.Builder> deletePermissionVersionRequest) Deletes one version of a customer managed permission.deletePermissionVersion
(DeletePermissionVersionRequest deletePermissionVersionRequest) Deletes one version of a customer managed permission.deleteResourceShare
(Consumer<DeleteResourceShareRequest.Builder> deleteResourceShareRequest) Deletes the specified resource share.deleteResourceShare
(DeleteResourceShareRequest deleteResourceShareRequest) Deletes the specified resource share.disassociateResourceShare
(Consumer<DisassociateResourceShareRequest.Builder> disassociateResourceShareRequest) Removes the specified principals or resources from participating in the specified resource share.disassociateResourceShare
(DisassociateResourceShareRequest disassociateResourceShareRequest) Removes the specified principals or resources from participating in the specified resource share.disassociateResourceSharePermission
(Consumer<DisassociateResourceSharePermissionRequest.Builder> disassociateResourceSharePermissionRequest) Removes a managed permission from a resource share.disassociateResourceSharePermission
(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest) Removes a managed permission from a resource share.Enables resource sharing within your organization in Organizations.enableSharingWithAwsOrganization
(Consumer<EnableSharingWithAwsOrganizationRequest.Builder> enableSharingWithAwsOrganizationRequest) Enables resource sharing within your organization in Organizations.enableSharingWithAwsOrganization
(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) Enables resource sharing within your organization in Organizations.default CompletableFuture
<GetPermissionResponse> getPermission
(Consumer<GetPermissionRequest.Builder> getPermissionRequest) Retrieves the contents of a managed permission in JSON format.default CompletableFuture
<GetPermissionResponse> getPermission
(GetPermissionRequest getPermissionRequest) Retrieves the contents of a managed permission in JSON format.getResourcePolicies
(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) Retrieves the resource policies for the specified resources that you own and have shared.getResourcePolicies
(GetResourcePoliciesRequest getResourcePoliciesRequest) Retrieves the resource policies for the specified resources that you own and have shared.default GetResourcePoliciesPublisher
getResourcePoliciesPaginator
(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) This is a variant ofgetResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.default GetResourcePoliciesPublisher
getResourcePoliciesPaginator
(GetResourcePoliciesRequest getResourcePoliciesRequest) This is a variant ofgetResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.getResourceShareAssociations
(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) Retrieves the lists of resources and principals that associated for resource shares that you own.getResourceShareAssociations
(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) Retrieves the lists of resources and principals that associated for resource shares that you own.getResourceShareAssociationsPaginator
(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) This is a variant ofgetResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)
operation.getResourceShareAssociationsPaginator
(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) This is a variant ofgetResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)
operation.Retrieves details about invitations that you have received for resource shares.getResourceShareInvitations
(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) Retrieves details about invitations that you have received for resource shares.getResourceShareInvitations
(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) Retrieves details about invitations that you have received for resource shares.This is a variant ofgetResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)
operation.getResourceShareInvitationsPaginator
(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) This is a variant ofgetResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)
operation.getResourceShareInvitationsPaginator
(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) This is a variant ofgetResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)
operation.getResourceShares
(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) Retrieves details about the resource shares that you own or that are shared with you.getResourceShares
(GetResourceSharesRequest getResourceSharesRequest) Retrieves details about the resource shares that you own or that are shared with you.default GetResourceSharesPublisher
getResourceSharesPaginator
(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) This is a variant ofgetResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)
operation.default GetResourceSharesPublisher
getResourceSharesPaginator
(GetResourceSharesRequest getResourceSharesRequest) This is a variant ofgetResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)
operation.listPendingInvitationResources
(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) Lists the resources in a resource share that is shared with you but for which the invitation is stillPENDING
.listPendingInvitationResources
(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) Lists the resources in a resource share that is shared with you but for which the invitation is stillPENDING
.listPendingInvitationResourcesPaginator
(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) This is a variant oflistPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.listPendingInvitationResourcesPaginator
(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) This is a variant oflistPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.listPermissionAssociations
(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) Lists information about the managed permission and its associations to any resource shares that use this managed permission.listPermissionAssociations
(ListPermissionAssociationsRequest listPermissionAssociationsRequest) Lists information about the managed permission and its associations to any resource shares that use this managed permission.listPermissionAssociationsPaginator
(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) This is a variant oflistPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.listPermissionAssociationsPaginator
(ListPermissionAssociationsRequest listPermissionAssociationsRequest) This is a variant oflistPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.default CompletableFuture
<ListPermissionsResponse> listPermissions
(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) Retrieves a list of available RAM permissions that you can use for the supported resource types.default CompletableFuture
<ListPermissionsResponse> listPermissions
(ListPermissionsRequest listPermissionsRequest) Retrieves a list of available RAM permissions that you can use for the supported resource types.default ListPermissionsPublisher
listPermissionsPaginator
(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.default ListPermissionsPublisher
listPermissionsPaginator
(ListPermissionsRequest listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.listPermissionVersions
(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) Lists the available versions of the specified RAM permission.listPermissionVersions
(ListPermissionVersionsRequest listPermissionVersionsRequest) Lists the available versions of the specified RAM permission.default ListPermissionVersionsPublisher
listPermissionVersionsPaginator
(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) This is a variant oflistPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.default ListPermissionVersionsPublisher
listPermissionVersionsPaginator
(ListPermissionVersionsRequest listPermissionVersionsRequest) This is a variant oflistPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.default CompletableFuture
<ListPrincipalsResponse> listPrincipals
(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) Lists the principals that you are sharing resources with or that are sharing resources with you.default CompletableFuture
<ListPrincipalsResponse> listPrincipals
(ListPrincipalsRequest listPrincipalsRequest) Lists the principals that you are sharing resources with or that are sharing resources with you.default ListPrincipalsPublisher
listPrincipalsPaginator
(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) This is a variant oflistPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.default ListPrincipalsPublisher
listPrincipalsPaginator
(ListPrincipalsRequest listPrincipalsRequest) This is a variant oflistPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.listReplacePermissionAssociationsWork
(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.listReplacePermissionAssociationsWork
(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.listReplacePermissionAssociationsWorkPaginator
(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) This is a variant oflistReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.listReplacePermissionAssociationsWorkPaginator
(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) This is a variant oflistReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.default CompletableFuture
<ListResourcesResponse> listResources
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Lists the resources that you added to a resource share or the resources that are shared with you.default CompletableFuture
<ListResourcesResponse> listResources
(ListResourcesRequest listResourcesRequest) Lists the resources that you added to a resource share or the resources that are shared with you.listResourceSharePermissions
(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest) Lists the RAM permissions that are associated with a resource share.listResourceSharePermissions
(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) Lists the RAM permissions that are associated with a resource share.listResourceSharePermissionsPaginator
(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest) This is a variant oflistResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)
operation.listResourceSharePermissionsPaginator
(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) This is a variant oflistResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)
operation.default ListResourcesPublisher
listResourcesPaginator
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.default ListResourcesPublisher
listResourcesPaginator
(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.listResourceTypes
(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) Lists the resource types that can be shared by RAM.listResourceTypes
(ListResourceTypesRequest listResourceTypesRequest) Lists the resource types that can be shared by RAM.default ListResourceTypesPublisher
listResourceTypesPaginator
(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) This is a variant oflistResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.default ListResourceTypesPublisher
listResourceTypesPaginator
(ListResourceTypesRequest listResourceTypesRequest) This is a variant oflistResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.promotePermissionCreatedFromPolicy
(Consumer<PromotePermissionCreatedFromPolicyRequest.Builder> promotePermissionCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.promotePermissionCreatedFromPolicy
(PromotePermissionCreatedFromPolicyRequest promotePermissionCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.promoteResourceShareCreatedFromPolicy
(Consumer<PromoteResourceShareCreatedFromPolicyRequest.Builder> promoteResourceShareCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.promoteResourceShareCreatedFromPolicy
(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.rejectResourceShareInvitation
(Consumer<RejectResourceShareInvitationRequest.Builder> rejectResourceShareInvitationRequest) Rejects an invitation to a resource share from another Amazon Web Services account.rejectResourceShareInvitation
(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest) Rejects an invitation to a resource share from another Amazon Web Services account.replacePermissionAssociations
(Consumer<ReplacePermissionAssociationsRequest.Builder> replacePermissionAssociationsRequest) Updates all resource shares that use a managed permission to a different managed permission.replacePermissionAssociations
(ReplacePermissionAssociationsRequest replacePermissionAssociationsRequest) Updates all resource shares that use a managed permission to a different managed permission.default RamServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsetDefaultPermissionVersion
(Consumer<SetDefaultPermissionVersionRequest.Builder> setDefaultPermissionVersionRequest) Designates the specified version number as the default version for the specified customer managed permission.setDefaultPermissionVersion
(SetDefaultPermissionVersionRequest setDefaultPermissionVersionRequest) Designates the specified version number as the default version for the specified customer managed permission.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tag keys and values to a resource share or managed permission.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tag keys and values to a resource share or managed permission.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tag key and value pairs from the specified resource share or managed permission.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tag key and value pairs from the specified resource share or managed permission.updateResourceShare
(Consumer<UpdateResourceShareRequest.Builder> updateResourceShareRequest) Modifies some of the properties of the specified resource share.updateResourceShare
(UpdateResourceShareRequest updateResourceShareRequest) Modifies some of the properties of the specified resource share.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createPermission
default CompletableFuture<CreatePermissionResponse> createPermission(CreatePermissionRequest createPermissionRequest) 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.
- Parameters:
createPermissionRequest
-- Returns:
- A Java Future containing the result of the CreatePermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPermission
default CompletableFuture<CreatePermissionResponse> createPermission(Consumer<CreatePermissionRequest.Builder> createPermissionRequest) 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.
This is a convenience which creates an instance of the
CreatePermissionRequest.Builder
avoiding the need to create one manually viaCreatePermissionRequest.builder()
- Parameters:
createPermissionRequest
- AConsumer
that will call methods onCreatePermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPermissionVersion
default CompletableFuture<CreatePermissionVersionResponse> createPermissionVersion(CreatePermissionVersionRequest createPermissionVersionRequest) 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.
- Parameters:
createPermissionVersionRequest
-- Returns:
- A Java Future containing the result of the CreatePermissionVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPermissionVersion
default CompletableFuture<CreatePermissionVersionResponse> createPermissionVersion(Consumer<CreatePermissionVersionRequest.Builder> createPermissionVersionRequest) 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.
This is a convenience which creates an instance of the
CreatePermissionVersionRequest.Builder
avoiding the need to create one manually viaCreatePermissionVersionRequest.builder()
- Parameters:
createPermissionVersionRequest
- AConsumer
that will call methods onCreatePermissionVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePermissionVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermission
default CompletableFuture<DeletePermissionResponse> deletePermission(DeletePermissionRequest deletePermissionRequest) 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.
- Parameters:
deletePermissionRequest
-- Returns:
- A Java Future containing the result of the DeletePermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermission
default CompletableFuture<DeletePermissionResponse> deletePermission(Consumer<DeletePermissionRequest.Builder> deletePermissionRequest) 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.
This is a convenience which creates an instance of the
DeletePermissionRequest.Builder
avoiding the need to create one manually viaDeletePermissionRequest.builder()
- Parameters:
deletePermissionRequest
- AConsumer
that will call methods onDeletePermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermissionVersion
default CompletableFuture<DeletePermissionVersionResponse> deletePermissionVersion(DeletePermissionVersionRequest deletePermissionVersionRequest) 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.
- Parameters:
deletePermissionVersionRequest
-- Returns:
- A Java Future containing the result of the DeletePermissionVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermissionVersion
default CompletableFuture<DeletePermissionVersionResponse> deletePermissionVersion(Consumer<DeletePermissionVersionRequest.Builder> deletePermissionVersionRequest) 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.
This is a convenience which creates an instance of the
DeletePermissionVersionRequest.Builder
avoiding the need to create one manually viaDeletePermissionVersionRequest.builder()
- Parameters:
deletePermissionVersionRequest
- AConsumer
that will call methods onDeletePermissionVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePermissionVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableSharingWithAwsOrganization
default CompletableFuture<EnableSharingWithAwsOrganizationResponse> enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) 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.
- Parameters:
enableSharingWithAwsOrganizationRequest
-- Returns:
- A Java Future containing the result of the EnableSharingWithAwsOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableSharingWithAwsOrganization
default CompletableFuture<EnableSharingWithAwsOrganizationResponse> enableSharingWithAwsOrganization(Consumer<EnableSharingWithAwsOrganizationRequest.Builder> enableSharingWithAwsOrganizationRequest) 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.
This is a convenience which creates an instance of the
EnableSharingWithAwsOrganizationRequest.Builder
avoiding the need to create one manually viaEnableSharingWithAwsOrganizationRequest.builder()
- Parameters:
enableSharingWithAwsOrganizationRequest
- AConsumer
that will call methods onEnableSharingWithAwsOrganizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EnableSharingWithAwsOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableSharingWithAwsOrganization
default CompletableFuture<EnableSharingWithAwsOrganizationResponse> enableSharingWithAwsOrganization()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.
- Returns:
- A Java Future containing the result of the EnableSharingWithAwsOrganization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPermission
default CompletableFuture<GetPermissionResponse> getPermission(GetPermissionRequest getPermissionRequest) Retrieves the contents of a managed permission in JSON format.
- Parameters:
getPermissionRequest
-- Returns:
- A Java Future containing the result of the GetPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPermission
default CompletableFuture<GetPermissionResponse> getPermission(Consumer<GetPermissionRequest.Builder> getPermissionRequest) Retrieves the contents of a managed permission in JSON format.
This is a convenience which creates an instance of the
GetPermissionRequest.Builder
avoiding the need to create one manually viaGetPermissionRequest.builder()
- Parameters:
getPermissionRequest
- AConsumer
that will call methods onGetPermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicies
default CompletableFuture<GetResourcePoliciesResponse> getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest) Retrieves the resource policies for the specified resources that you own and have shared.
- Parameters:
getResourcePoliciesRequest
-- Returns:
- A Java Future containing the result of the GetResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePolicies
default CompletableFuture<GetResourcePoliciesResponse> getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) Retrieves the resource policies for the specified resources that you own and have shared.
This is a convenience which creates an instance of the
GetResourcePoliciesRequest.Builder
avoiding the need to create one manually viaGetResourcePoliciesRequest.builder()
- Parameters:
getResourcePoliciesRequest
- AConsumer
that will call methods onGetResourcePoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePoliciesPaginator
default GetResourcePoliciesPublisher getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest) This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.- Parameters:
getResourcePoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePoliciesPaginator
default GetResourcePoliciesPublisher getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesPublisher publisher = client.getResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.
This is a convenience which creates an instance of the
GetResourcePoliciesRequest.Builder
avoiding the need to create one manually viaGetResourcePoliciesRequest.builder()
- Parameters:
getResourcePoliciesRequest
- AConsumer
that will call methods onGetResourcePoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPendingInvitationResources
default CompletableFuture<ListPendingInvitationResourcesResponse> listPendingInvitationResources(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.- Parameters:
listPendingInvitationResourcesRequest
-- Returns:
- A Java Future containing the result of the ListPendingInvitationResources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPendingInvitationResources
default CompletableFuture<ListPendingInvitationResourcesResponse> listPendingInvitationResources(Consumer<ListPendingInvitationResourcesRequest.Builder> 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.
This is a convenience which creates an instance of the
ListPendingInvitationResourcesRequest.Builder
avoiding the need to create one manually viaListPendingInvitationResourcesRequest.builder()
- Parameters:
listPendingInvitationResourcesRequest
- AConsumer
that will call methods onListPendingInvitationResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPendingInvitationResources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPendingInvitationResourcesPaginator
default ListPendingInvitationResourcesPublisher listPendingInvitationResourcesPaginator(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) This is a variant of
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesPublisher publisher = client.listPendingInvitationResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesPublisher publisher = client.listPendingInvitationResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.- Parameters:
listPendingInvitationResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPendingInvitationResourcesPaginator
default ListPendingInvitationResourcesPublisher listPendingInvitationResourcesPaginator(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) This is a variant of
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesPublisher publisher = client.listPendingInvitationResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesPublisher publisher = client.listPendingInvitationResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListPendingInvitationResourcesRequest.Builder
avoiding the need to create one manually viaListPendingInvitationResourcesRequest.builder()
- Parameters:
listPendingInvitationResourcesRequest
- AConsumer
that will call methods onListPendingInvitationResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionAssociations
default CompletableFuture<ListPermissionAssociationsResponse> listPermissionAssociations(ListPermissionAssociationsRequest listPermissionAssociationsRequest) 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.
- Parameters:
listPermissionAssociationsRequest
-- Returns:
- A Java Future containing the result of the ListPermissionAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionAssociations
default CompletableFuture<ListPermissionAssociationsResponse> listPermissionAssociations(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) 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.
This is a convenience which creates an instance of the
ListPermissionAssociationsRequest.Builder
avoiding the need to create one manually viaListPermissionAssociationsRequest.builder()
- Parameters:
listPermissionAssociationsRequest
- AConsumer
that will call methods onListPermissionAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPermissionAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionAssociationsPaginator
default ListPermissionAssociationsPublisher listPermissionAssociationsPaginator(ListPermissionAssociationsRequest listPermissionAssociationsRequest) This is a variant of
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsPublisher publisher = client.listPermissionAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsPublisher publisher = client.listPermissionAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.- Parameters:
listPermissionAssociationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionAssociationsPaginator
default ListPermissionAssociationsPublisher listPermissionAssociationsPaginator(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) This is a variant of
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsPublisher publisher = client.listPermissionAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsPublisher publisher = client.listPermissionAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListPermissionAssociationsRequest.Builder
avoiding the need to create one manually viaListPermissionAssociationsRequest.builder()
- Parameters:
listPermissionAssociationsRequest
- AConsumer
that will call methods onListPermissionAssociationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionVersions
default CompletableFuture<ListPermissionVersionsResponse> listPermissionVersions(ListPermissionVersionsRequest listPermissionVersionsRequest) Lists the available versions of the specified RAM permission.
- Parameters:
listPermissionVersionsRequest
-- Returns:
- A Java Future containing the result of the ListPermissionVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionVersions
default CompletableFuture<ListPermissionVersionsResponse> listPermissionVersions(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) Lists the available versions of the specified RAM permission.
This is a convenience which creates an instance of the
ListPermissionVersionsRequest.Builder
avoiding the need to create one manually viaListPermissionVersionsRequest.builder()
- Parameters:
listPermissionVersionsRequest
- AConsumer
that will call methods onListPermissionVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPermissionVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionVersionsPaginator
default ListPermissionVersionsPublisher listPermissionVersionsPaginator(ListPermissionVersionsRequest listPermissionVersionsRequest) This is a variant of
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsPublisher publisher = client.listPermissionVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPermissionVersionsPublisher publisher = client.listPermissionVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.- Parameters:
listPermissionVersionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionVersionsPaginator
default ListPermissionVersionsPublisher listPermissionVersionsPaginator(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) This is a variant of
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsPublisher publisher = client.listPermissionVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPermissionVersionsPublisher publisher = client.listPermissionVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListPermissionVersionsRequest.Builder
avoiding the need to create one manually viaListPermissionVersionsRequest.builder()
- Parameters:
listPermissionVersionsRequest
- AConsumer
that will call methods onListPermissionVersionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissions
default CompletableFuture<ListPermissionsResponse> listPermissions(ListPermissionsRequest listPermissionsRequest) Retrieves a list of available RAM permissions that you can use for the supported resource types.
- Parameters:
listPermissionsRequest
-- Returns:
- A Java Future containing the result of the ListPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissions
default CompletableFuture<ListPermissionsResponse> listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) Retrieves a list of available RAM permissions that you can use for the supported resource types.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builder
avoiding the need to create one manually viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPermissions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionsPaginator
default ListPermissionsPublisher listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) This is a variant of
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPermissionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.- Parameters:
listPermissionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionsPaginator
default ListPermissionsPublisher listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant of
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPermissionsPublisher publisher = client.listPermissionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPermissionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPermissionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builder
avoiding the need to create one manually viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrincipals
default CompletableFuture<ListPrincipalsResponse> listPrincipals(ListPrincipalsRequest listPrincipalsRequest) Lists the principals that you are sharing resources with or that are sharing resources with you.
- Parameters:
listPrincipalsRequest
-- Returns:
- A Java Future containing the result of the ListPrincipals operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrincipals
default CompletableFuture<ListPrincipalsResponse> listPrincipals(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) Lists the principals that you are sharing resources with or that are sharing resources with you.
This is a convenience which creates an instance of the
ListPrincipalsRequest.Builder
avoiding the need to create one manually viaListPrincipalsRequest.builder()
- Parameters:
listPrincipalsRequest
- AConsumer
that will call methods onListPrincipalsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListPrincipals operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrincipalsPaginator
default ListPrincipalsPublisher listPrincipalsPaginator(ListPrincipalsRequest listPrincipalsRequest) This is a variant of
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsPublisher publisher = client.listPrincipalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPrincipalsPublisher publisher = client.listPrincipalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPrincipalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPrincipalsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.- Parameters:
listPrincipalsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPrincipalsPaginator
default ListPrincipalsPublisher listPrincipalsPaginator(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) This is a variant of
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsPublisher publisher = client.listPrincipalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListPrincipalsPublisher publisher = client.listPrincipalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListPrincipalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListPrincipalsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.
This is a convenience which creates an instance of the
ListPrincipalsRequest.Builder
avoiding the need to create one manually viaListPrincipalsRequest.builder()
- Parameters:
listPrincipalsRequest
- AConsumer
that will call methods onListPrincipalsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplacePermissionAssociationsWork
default CompletableFuture<ListReplacePermissionAssociationsWorkResponse> listReplacePermissionAssociationsWork(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
- Parameters:
listReplacePermissionAssociationsWorkRequest
-- Returns:
- A Java Future containing the result of the ListReplacePermissionAssociationsWork operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
response of a previous call to this operation. - InvalidParameterException The operation failed because a parameter you specified isn't valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplacePermissionAssociationsWork
default CompletableFuture<ListReplacePermissionAssociationsWorkResponse> listReplacePermissionAssociationsWork(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
This is a convenience which creates an instance of the
ListReplacePermissionAssociationsWorkRequest.Builder
avoiding the need to create one manually viaListReplacePermissionAssociationsWorkRequest.builder()
- Parameters:
listReplacePermissionAssociationsWorkRequest
- AConsumer
that will call methods onListReplacePermissionAssociationsWorkRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListReplacePermissionAssociationsWork operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
response of a previous call to this operation. - InvalidParameterException The operation failed because a parameter you specified isn't valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplacePermissionAssociationsWorkPaginator
default ListReplacePermissionAssociationsWorkPublisher listReplacePermissionAssociationsWorkPaginator(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) This is a variant of
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkPublisher publisher = client.listReplacePermissionAssociationsWorkPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkPublisher publisher = client.listReplacePermissionAssociationsWorkPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.- Parameters:
listReplacePermissionAssociationsWorkRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
response of a previous call to this operation. - InvalidParameterException The operation failed because a parameter you specified isn't valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listReplacePermissionAssociationsWorkPaginator
default ListReplacePermissionAssociationsWorkPublisher listReplacePermissionAssociationsWorkPaginator(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) This is a variant of
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkPublisher publisher = client.listReplacePermissionAssociationsWorkPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkPublisher publisher = client.listReplacePermissionAssociationsWorkPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.
This is a convenience which creates an instance of the
ListReplacePermissionAssociationsWorkRequest.Builder
avoiding the need to create one manually viaListReplacePermissionAssociationsWorkRequest.builder()
- Parameters:
listReplacePermissionAssociationsWorkRequest
- AConsumer
that will call methods onListReplacePermissionAssociationsWorkRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
response of a previous call to this operation. - InvalidParameterException The operation failed because a parameter you specified isn't valid.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourceTypes
default CompletableFuture<ListResourceTypesResponse> listResourceTypes(ListResourceTypesRequest listResourceTypesRequest) Lists the resource types that can be shared by RAM.
- Parameters:
listResourceTypesRequest
-- Returns:
- A Java Future containing the result of the ListResourceTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The operation failed because the specified value for
NextToken
isn't valid. You must specify a value you received in theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The operation failed because the specified value for
- See Also:
-
listResourceTypes
default CompletableFuture<ListResourceTypesResponse> listResourceTypes(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) Lists the resource types that can be shared by RAM.
This is a convenience which creates an instance of the
ListResourceTypesRequest.Builder
avoiding the need to create one manually viaListResourceTypesRequest.builder()
- Parameters:
listResourceTypesRequest
- AConsumer
that will call methods onListResourceTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The operation failed because the specified value for
NextToken
isn't valid. You must specify a value you received in theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The operation failed because the specified value for
- See Also:
-
listResourceTypesPaginator
default ListResourceTypesPublisher listResourceTypesPaginator(ListResourceTypesRequest listResourceTypesRequest) This is a variant of
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesPublisher publisher = client.listResourceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListResourceTypesPublisher publisher = client.listResourceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListResourceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListResourceTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.- Parameters:
listResourceTypesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The operation failed because the specified value for
NextToken
isn't valid. You must specify a value you received in theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The operation failed because the specified value for
- See Also:
-
listResourceTypesPaginator
default ListResourceTypesPublisher listResourceTypesPaginator(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) This is a variant of
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesPublisher publisher = client.listResourceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListResourceTypesPublisher publisher = client.listResourceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListResourceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListResourceTypesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.
This is a convenience which creates an instance of the
ListResourceTypesRequest.Builder
avoiding the need to create one manually viaListResourceTypesRequest.builder()
- Parameters:
listResourceTypesRequest
- AConsumer
that will call methods onListResourceTypesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The operation failed because the specified value for
NextToken
isn't valid. You must specify a value you received in theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The operation failed because the specified value for
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(ListResourcesRequest listResourcesRequest) Lists the resources that you added to a resource share or the resources that are shared with you.
- Parameters:
listResourcesRequest
-- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResources
default CompletableFuture<ListResourcesResponse> listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Lists the resources that you added to a resource share or the resources that are shared with you.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
This is a variant of
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListResourcesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.- Parameters:
listResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcesPaginator
default ListResourcesPublisher listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant of
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ram.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ram.paginators.ListResourcesPublisher publisher = client.listResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ram.model.ListResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ram.model.ListResourcesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 theNextToken
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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
promotePermissionCreatedFromPolicy
default CompletableFuture<PromotePermissionCreatedFromPolicyResponse> promotePermissionCreatedFromPolicy(PromotePermissionCreatedFromPolicyRequest promotePermissionCreatedFromPolicyRequest) 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 usingReplacePermsissionAssociations
. However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable customer managed permission to the newly promotedSTANDARD
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.
- Parameters:
promotePermissionCreatedFromPolicyRequest
-- Returns:
- A Java Future containing the result of the PromotePermissionCreatedFromPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
promotePermissionCreatedFromPolicy
default CompletableFuture<PromotePermissionCreatedFromPolicyResponse> promotePermissionCreatedFromPolicy(Consumer<PromotePermissionCreatedFromPolicyRequest.Builder> promotePermissionCreatedFromPolicyRequest) 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 usingReplacePermsissionAssociations
. However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable customer managed permission to the newly promotedSTANDARD
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.
This is a convenience which creates an instance of the
PromotePermissionCreatedFromPolicyRequest.Builder
avoiding the need to create one manually viaPromotePermissionCreatedFromPolicyRequest.builder()
- Parameters:
promotePermissionCreatedFromPolicyRequest
- AConsumer
that will call methods onPromotePermissionCreatedFromPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PromotePermissionCreatedFromPolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
replacePermissionAssociations
default CompletableFuture<ReplacePermissionAssociationsResponse> replacePermissionAssociations(ReplacePermissionAssociationsRequest replacePermissionAssociationsRequest) 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
andtoPermissionArn
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.
- Parameters:
replacePermissionAssociationsRequest
-- Returns:
- A Java Future containing the result of the ReplacePermissionAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
replacePermissionAssociations
default CompletableFuture<ReplacePermissionAssociationsResponse> replacePermissionAssociations(Consumer<ReplacePermissionAssociationsRequest.Builder> replacePermissionAssociationsRequest) 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
andtoPermissionArn
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.
This is a convenience which creates an instance of the
ReplacePermissionAssociationsRequest.Builder
avoiding the need to create one manually viaReplacePermissionAssociationsRequest.builder()
- Parameters:
replacePermissionAssociationsRequest
- AConsumer
that will call methods onReplacePermissionAssociationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ReplacePermissionAssociations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setDefaultPermissionVersion
default CompletableFuture<SetDefaultPermissionVersionResponse> setDefaultPermissionVersion(SetDefaultPermissionVersionRequest setDefaultPermissionVersionRequest) 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.
- Parameters:
setDefaultPermissionVersionRequest
-- Returns:
- A Java Future containing the result of the SetDefaultPermissionVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setDefaultPermissionVersion
default CompletableFuture<SetDefaultPermissionVersionResponse> setDefaultPermissionVersion(Consumer<SetDefaultPermissionVersionRequest.Builder> setDefaultPermissionVersionRequest) 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.
This is a convenience which creates an instance of the
SetDefaultPermissionVersionRequest.Builder
avoiding the need to create one manually viaSetDefaultPermissionVersionRequest.builder()
- Parameters:
setDefaultPermissionVersionRequest
- AConsumer
that will call methods onSetDefaultPermissionVersionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetDefaultPermissionVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tag key and value pairs from the specified resource share or managed permission.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tag key and value pairs from the specified resource share or managed permission.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- RamException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aRamAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRamAsyncClient
.