Interface RamClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface RamClient extends AwsClient
Service client for accessing RAM. This can be created using the staticbuilder()method.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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptResourceShareInvitation
default AcceptResourceShareInvitationResponse acceptResourceShareInvitation(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest) throws MalformedArnException, OperationNotPermittedException, ResourceShareInvitationArnNotFoundException, ResourceShareInvitationAlreadyAcceptedException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, ServerInternalException, ServiceUnavailableException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.
- Parameters:
acceptResourceShareInvitationRequest-- Returns:
- Result of the AcceptResourceShareInvitation operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException- The operation failed because the specified invitation was already accepted.ResourceShareInvitationAlreadyRejectedException- The operation failed because the specified invitation was already rejected.ResourceShareInvitationExpiredException- The operation failed because the specified invitation is past its expiration date and time.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.InvalidClientTokenException- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.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.AwsServiceException- See Also:
- AWS API Documentation
-
acceptResourceShareInvitation
default AcceptResourceShareInvitationResponse acceptResourceShareInvitation(Consumer<AcceptResourceShareInvitationRequest.Builder> acceptResourceShareInvitationRequest) throws MalformedArnException, OperationNotPermittedException, ResourceShareInvitationArnNotFoundException, ResourceShareInvitationAlreadyAcceptedException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, ServerInternalException, ServiceUnavailableException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.
This is a convenience which creates an instance of the
AcceptResourceShareInvitationRequest.Builderavoiding the need to create one manually viaAcceptResourceShareInvitationRequest.builder()- Parameters:
acceptResourceShareInvitationRequest- AConsumerthat will call methods onAcceptResourceShareInvitationRequest.Builderto create a request.- Returns:
- Result of the AcceptResourceShareInvitation operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException- The operation failed because the specified invitation was already accepted.ResourceShareInvitationAlreadyRejectedException- The operation failed because the specified invitation was already rejected.ResourceShareInvitationExpiredException- The operation failed because the specified invitation is past its expiration date and time.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.InvalidClientTokenException- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.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.AwsServiceException- See Also:
- AWS API Documentation
-
associateResourceShare
default AssociateResourceShareResponse associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest) throws IdempotentParameterMismatchException, UnknownResourceException, InvalidStateTransitionException, ResourceShareLimitExceededException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, RamException
Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.
- Parameters:
associateResourceShareRequest-- Returns:
- Result of the AssociateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.UnknownResourceException- The operation failed because a specified resource couldn't be found.ThrottlingException- The operation failed because it exceeded the rate at which you are allowed to perform this operation. Please try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
associateResourceShare
default AssociateResourceShareResponse associateResourceShare(Consumer<AssociateResourceShareRequest.Builder> associateResourceShareRequest) throws IdempotentParameterMismatchException, UnknownResourceException, InvalidStateTransitionException, ResourceShareLimitExceededException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, RamException
Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.
This is a convenience which creates an instance of the
AssociateResourceShareRequest.Builderavoiding the need to create one manually viaAssociateResourceShareRequest.builder()- Parameters:
associateResourceShareRequest- AConsumerthat will call methods onAssociateResourceShareRequest.Builderto create a request.- Returns:
- Result of the AssociateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.UnknownResourceException- The operation failed because a specified resource couldn't be found.ThrottlingException- The operation failed because it exceeded the rate at which you are allowed to perform this operation. Please try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
associateResourceSharePermission
default AssociateResourceSharePermissionResponse associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.
- Parameters:
associateResourceSharePermissionRequest-- Returns:
- Result of the AssociateResourceSharePermission operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.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.AwsServiceException- See Also:
- AWS API Documentation
-
associateResourceSharePermission
default AssociateResourceSharePermissionResponse associateResourceSharePermission(Consumer<AssociateResourceSharePermissionRequest.Builder> associateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Adds or replaces the RAM permission for a resource type included in a resource share. You can have exactly one permission associated with each resource type in the resource share. You can add a new RAM permission only if there are currently no resources of that resource type currently in the resource share.
This is a convenience which creates an instance of the
AssociateResourceSharePermissionRequest.Builderavoiding the need to create one manually viaAssociateResourceSharePermissionRequest.builder()- Parameters:
associateResourceSharePermissionRequest- AConsumerthat will call methods onAssociateResourceSharePermissionRequest.Builderto create a request.- Returns:
- Result of the AssociateResourceSharePermission operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.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.AwsServiceException- See Also:
- AWS API Documentation
-
createPermission
default CreatePermissionResponse createPermission(CreatePermissionRequest createPermissionRequest) throws InvalidParameterException, InvalidPolicyException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, PermissionAlreadyExistsException, MalformedPolicyTemplateException, InvalidClientTokenException, PermissionLimitExceededException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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:
- Result of the CreatePermission operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPermission
default CreatePermissionResponse createPermission(Consumer<CreatePermissionRequest.Builder> createPermissionRequest) throws InvalidParameterException, InvalidPolicyException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, PermissionAlreadyExistsException, MalformedPolicyTemplateException, InvalidClientTokenException, PermissionLimitExceededException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaCreatePermissionRequest.builder()- Parameters:
createPermissionRequest- AConsumerthat will call methods onCreatePermissionRequest.Builderto create a request.- Returns:
- Result of the CreatePermission operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPermissionVersion
default CreatePermissionVersionResponse createPermissionVersion(CreatePermissionVersionRequest createPermissionVersionRequest) throws InvalidParameterException, InvalidPolicyException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, MalformedPolicyTemplateException, MalformedArnException, InvalidClientTokenException, IdempotentParameterMismatchException, PermissionVersionsLimitExceededException, AwsServiceException, SdkClientException, RamException
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:
- Result of the CreatePermissionVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPermissionVersion
default CreatePermissionVersionResponse createPermissionVersion(Consumer<CreatePermissionVersionRequest.Builder> createPermissionVersionRequest) throws InvalidParameterException, InvalidPolicyException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, MalformedPolicyTemplateException, MalformedArnException, InvalidClientTokenException, IdempotentParameterMismatchException, PermissionVersionsLimitExceededException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaCreatePermissionVersionRequest.builder()- Parameters:
createPermissionVersionRequest- AConsumerthat will call methods onCreatePermissionVersionRequest.Builderto create a request.- Returns:
- Result of the CreatePermissionVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createResourceShare
default CreateResourceShareResponse createResourceShare(CreateResourceShareRequest createResourceShareRequest) throws IdempotentParameterMismatchException, InvalidStateTransitionException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ResourceShareLimitExceededException, TagPolicyViolationException, TagLimitExceededException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.
Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.
- Parameters:
createResourceShareRequest-- Returns:
- Result of the CreateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.UnknownResourceException- The operation failed because a specified resource couldn't be found.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.TagPolicyViolationException- The operation failed because the specified tag key is a reserved word and can't be used.TagLimitExceededException- The operation failed because it would exceed the limit for tags for your Amazon Web Services account.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
createResourceShare
default CreateResourceShareResponse createResourceShare(Consumer<CreateResourceShareRequest.Builder> createResourceShareRequest) throws IdempotentParameterMismatchException, InvalidStateTransitionException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ResourceShareLimitExceededException, TagPolicyViolationException, TagLimitExceededException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Creates a resource share. You can provide a list of the Amazon Resource Names (ARNs) for the resources that you want to share, a list of principals you want to share the resources with, and the permissions to grant those principals.
Sharing a resource makes it available for use by principals outside of the Amazon Web Services account that created the resource. Sharing doesn't change any permissions or quotas that apply to the resource in the account that created it.
This is a convenience which creates an instance of the
CreateResourceShareRequest.Builderavoiding the need to create one manually viaCreateResourceShareRequest.builder()- Parameters:
createResourceShareRequest- AConsumerthat will call methods onCreateResourceShareRequest.Builderto create a request.- Returns:
- Result of the CreateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.UnknownResourceException- The operation failed because a specified resource couldn't be found.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.TagPolicyViolationException- The operation failed because the specified tag key is a reserved word and can't be used.TagLimitExceededException- The operation failed because it would exceed the limit for tags for your Amazon Web Services account.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermission
default DeletePermissionResponse deletePermission(DeletePermissionRequest deletePermissionRequest) throws MalformedArnException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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:
- Result of the DeletePermission operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermission
default DeletePermissionResponse deletePermission(Consumer<DeletePermissionRequest.Builder> deletePermissionRequest) throws MalformedArnException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaDeletePermissionRequest.builder()- Parameters:
deletePermissionRequest- AConsumerthat will call methods onDeletePermissionRequest.Builderto create a request.- Returns:
- Result of the DeletePermission operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermissionVersion
default DeletePermissionVersionResponse deletePermissionVersion(DeletePermissionVersionRequest deletePermissionVersionRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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:
- Result of the DeletePermissionVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePermissionVersion
default DeletePermissionVersionResponse deletePermissionVersion(Consumer<DeletePermissionVersionRequest.Builder> deletePermissionVersionRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaDeletePermissionVersionRequest.builder()- Parameters:
deletePermissionVersionRequest- AConsumerthat will call methods onDeletePermissionVersionRequest.Builderto create a request.- Returns:
- Result of the DeletePermissionVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourceShare
default DeleteResourceShareResponse deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest) throws OperationNotPermittedException, IdempotentParameterMismatchException, InvalidStateTransitionException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Deletes the specified resource share.
This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this resource share.
- Parameters:
deleteResourceShareRequest-- Returns:
- Result of the DeleteResourceShare operation returned by the service.
- Throws:
OperationNotPermittedException- The operation failed because the requested operation isn't permitted.IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.UnknownResourceException- The operation failed because a specified resource couldn't be found.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourceShare
default DeleteResourceShareResponse deleteResourceShare(Consumer<DeleteResourceShareRequest.Builder> deleteResourceShareRequest) throws OperationNotPermittedException, IdempotentParameterMismatchException, InvalidStateTransitionException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Deletes the specified resource share.
This doesn't delete any of the resources that were associated with the resource share; it only stops the sharing of those resources through this resource share.
This is a convenience which creates an instance of the
DeleteResourceShareRequest.Builderavoiding the need to create one manually viaDeleteResourceShareRequest.builder()- Parameters:
deleteResourceShareRequest- AConsumerthat will call methods onDeleteResourceShareRequest.Builderto create a request.- Returns:
- Result of the DeleteResourceShare operation returned by the service.
- Throws:
OperationNotPermittedException- The operation failed because the requested operation isn't permitted.IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.UnknownResourceException- The operation failed because a specified resource couldn't be found.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateResourceShare
default DisassociateResourceShareResponse disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest) throws IdempotentParameterMismatchException, ResourceShareLimitExceededException, MalformedArnException, InvalidStateTransitionException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
Removes the specified principals or resources from participating in the specified resource share.
- Parameters:
disassociateResourceShareRequest-- Returns:
- Result of the DisassociateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.UnknownResourceException- The operation failed because a specified resource couldn't be found.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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateResourceShare
default DisassociateResourceShareResponse disassociateResourceShare(Consumer<DisassociateResourceShareRequest.Builder> disassociateResourceShareRequest) throws IdempotentParameterMismatchException, ResourceShareLimitExceededException, MalformedArnException, InvalidStateTransitionException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
Removes the specified principals or resources from participating in the specified resource share.
This is a convenience which creates an instance of the
DisassociateResourceShareRequest.Builderavoiding the need to create one manually viaDisassociateResourceShareRequest.builder()- Parameters:
disassociateResourceShareRequest- AConsumerthat will call methods onDisassociateResourceShareRequest.Builderto create a request.- Returns:
- Result of the DisassociateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.UnknownResourceException- The operation failed because a specified resource couldn't be found.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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateResourceSharePermission
default DisassociateResourceSharePermissionResponse disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidStateTransitionException, AwsServiceException, SdkClientException, RamException
Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.
- Parameters:
disassociateResourceSharePermissionRequest-- Returns:
- Result of the DisassociateResourceSharePermission operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateResourceSharePermission
default DisassociateResourceSharePermissionResponse disassociateResourceSharePermission(Consumer<DisassociateResourceSharePermissionRequest.Builder> disassociateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidStateTransitionException, AwsServiceException, SdkClientException, RamException
Removes a managed permission from a resource share. Permission changes take effect immediately. You can remove a managed permission from a resource share only if there are currently no resources of the relevant resource type currently attached to the resource share.
This is a convenience which creates an instance of the
DisassociateResourceSharePermissionRequest.Builderavoiding the need to create one manually viaDisassociateResourceSharePermissionRequest.builder()- Parameters:
disassociateResourceSharePermissionRequest- AConsumerthat will call methods onDisassociateResourceSharePermissionRequest.Builderto create a request.- Returns:
- Result of the DisassociateResourceSharePermission operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.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.AwsServiceException- See Also:
- AWS API Documentation
-
enableSharingWithAwsOrganization
default EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called
AWSServiceRoleForResourceAccessManagerthat 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:
- Result of the EnableSharingWithAwsOrganization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
enableSharingWithAwsOrganization
default EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization(Consumer<EnableSharingWithAwsOrganizationRequest.Builder> enableSharingWithAwsOrganizationRequest) throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called
AWSServiceRoleForResourceAccessManagerthat 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.Builderavoiding the need to create one manually viaEnableSharingWithAwsOrganizationRequest.builder()- Parameters:
enableSharingWithAwsOrganizationRequest- AConsumerthat will call methods onEnableSharingWithAwsOrganizationRequest.Builderto create a request.- Returns:
- Result of the EnableSharingWithAwsOrganization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
enableSharingWithAwsOrganization
default EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization() throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called
AWSServiceRoleForResourceAccessManagerthat 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:
- Result of the EnableSharingWithAwsOrganization operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest), AWS API Documentation
-
getPermission
default GetPermissionResponse getPermission(GetPermissionRequest getPermissionRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Retrieves the contents of a managed permission in JSON format.
- Parameters:
getPermissionRequest-- Returns:
- Result of the GetPermission operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getPermission
default GetPermissionResponse getPermission(Consumer<GetPermissionRequest.Builder> getPermissionRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Retrieves the contents of a managed permission in JSON format.
This is a convenience which creates an instance of the
GetPermissionRequest.Builderavoiding the need to create one manually viaGetPermissionRequest.builder()- Parameters:
getPermissionRequest- AConsumerthat will call methods onGetPermissionRequest.Builderto create a request.- Returns:
- Result of the GetPermission operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourcePolicies
default GetResourcePoliciesResponse getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves the resource policies for the specified resources that you own and have shared.
- Parameters:
getResourcePoliciesRequest-- Returns:
- Result of the GetResourcePolicies operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourcePolicies
default GetResourcePoliciesResponse getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaGetResourcePoliciesRequest.builder()- Parameters:
getResourcePoliciesRequest- AConsumerthat will call methods onGetResourcePoliciesRequest.Builderto create a request.- Returns:
- Result of the GetResourcePolicies operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourcePoliciesPaginator
default GetResourcePoliciesIterable getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client .getResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourcePoliciesPaginator
default GetResourcePoliciesIterable getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client .getResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaGetResourcePoliciesRequest.builder()- Parameters:
getResourcePoliciesRequest- AConsumerthat will call methods onGetResourcePoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareAssociations
default GetResourceShareAssociationsResponse getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves the lists of resources and principals that associated for resource shares that you own.
- Parameters:
getResourceShareAssociationsRequest-- Returns:
- Result of the GetResourceShareAssociations operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse of a previous call to this operation.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareAssociations
default GetResourceShareAssociationsResponse getResourceShareAssociations(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves the lists of resources and principals that associated for resource shares that you own.
This is a convenience which creates an instance of the
GetResourceShareAssociationsRequest.Builderavoiding the need to create one manually viaGetResourceShareAssociationsRequest.builder()- Parameters:
getResourceShareAssociationsRequest- AConsumerthat will call methods onGetResourceShareAssociationsRequest.Builderto create a request.- Returns:
- Result of the GetResourceShareAssociations operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse of a previous call to this operation.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareAssociationsPaginator
default GetResourceShareAssociationsIterable getResourceShareAssociationsPaginator(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client.getResourceShareAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client .getResourceShareAssociationsPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client.getResourceShareAssociationsPaginator(request); responses.iterator().forEachRemaining(....);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
getResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)operation.- Parameters:
getResourceShareAssociationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse of a previous call to this operation.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareAssociationsPaginator
default GetResourceShareAssociationsIterable getResourceShareAssociationsPaginator(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client.getResourceShareAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client .getResourceShareAssociationsPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client.getResourceShareAssociationsPaginator(request); responses.iterator().forEachRemaining(....);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
getResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)operation.
This is a convenience which creates an instance of the
GetResourceShareAssociationsRequest.Builderavoiding the need to create one manually viaGetResourceShareAssociationsRequest.builder()- Parameters:
getResourceShareAssociationsRequest- AConsumerthat will call methods onGetResourceShareAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse of a previous call to this operation.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareInvitations
default GetResourceShareInvitationsResponse getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves details about invitations that you have received for resource shares.
- Parameters:
getResourceShareInvitationsRequest-- Returns:
- Result of the GetResourceShareInvitations operation returned by the service.
- Throws:
ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException- The operation failed because the specified value forMaxResultsisn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareInvitations
default GetResourceShareInvitationsResponse getResourceShareInvitations(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves details about invitations that you have received for resource shares.
This is a convenience which creates an instance of the
GetResourceShareInvitationsRequest.Builderavoiding the need to create one manually viaGetResourceShareInvitationsRequest.builder()- Parameters:
getResourceShareInvitationsRequest- AConsumerthat will call methods onGetResourceShareInvitationsRequest.Builderto create a request.- Returns:
- Result of the GetResourceShareInvitations operation returned by the service.
- Throws:
ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException- The operation failed because the specified value forMaxResultsisn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareInvitations
default GetResourceShareInvitationsResponse getResourceShareInvitations() throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves details about invitations that you have received for resource shares.
- Returns:
- Result of the GetResourceShareInvitations operation returned by the service.
- Throws:
ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException- The operation failed because the specified value forMaxResultsisn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
getResourceShareInvitations(GetResourceShareInvitationsRequest), AWS API Documentation
-
getResourceShareInvitationsPaginator
default GetResourceShareInvitationsIterable getResourceShareInvitationsPaginator() throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client .getResourceShareInvitationsPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request); responses.iterator().forEachRemaining(....);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
getResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException- The operation failed because the specified value forMaxResultsisn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
getResourceShareInvitationsPaginator(GetResourceShareInvitationsRequest), AWS API Documentation
-
getResourceShareInvitationsPaginator
default GetResourceShareInvitationsIterable getResourceShareInvitationsPaginator(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client .getResourceShareInvitationsPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request); responses.iterator().forEachRemaining(....);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
getResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)operation.- Parameters:
getResourceShareInvitationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException- The operation failed because the specified value forMaxResultsisn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShareInvitationsPaginator
default GetResourceShareInvitationsIterable getResourceShareInvitationsPaginator(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client .getResourceShareInvitationsPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request); responses.iterator().forEachRemaining(....);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
getResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)operation.
This is a convenience which creates an instance of the
GetResourceShareInvitationsRequest.Builderavoiding the need to create one manually viaGetResourceShareInvitationsRequest.builder()- Parameters:
getResourceShareInvitationsRequest- AConsumerthat will call methods onGetResourceShareInvitationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException- The operation failed because the specified value forMaxResultsisn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShares
default GetResourceSharesResponse getResourceShares(GetResourceSharesRequest getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves details about the resource shares that you own or that are shared with you.
- Parameters:
getResourceSharesRequest-- Returns:
- Result of the GetResourceShares operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceShares
default GetResourceSharesResponse getResourceShares(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Retrieves details about the resource shares that you own or that are shared with you.
This is a convenience which creates an instance of the
GetResourceSharesRequest.Builderavoiding the need to create one manually viaGetResourceSharesRequest.builder()- Parameters:
getResourceSharesRequest- AConsumerthat will call methods onGetResourceSharesRequest.Builderto create a request.- Returns:
- Result of the GetResourceShares operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceSharesPaginator
default GetResourceSharesIterable getResourceSharesPaginator(GetResourceSharesRequest getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client.getResourceSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client .getResourceSharesPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourceSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client.getResourceSharesPaginator(request); responses.iterator().forEachRemaining(....);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
getResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)operation.- Parameters:
getResourceSharesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourceSharesPaginator
default GetResourceSharesIterable getResourceSharesPaginator(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
getResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client.getResourceSharesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client .getResourceSharesPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourceSharesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client.getResourceSharesPaginator(request); responses.iterator().forEachRemaining(....);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
getResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)operation.
This is a convenience which creates an instance of the
GetResourceSharesRequest.Builderavoiding the need to create one manually viaGetResourceSharesRequest.builder()- Parameters:
getResourceSharesRequest- AConsumerthat will call methods onGetResourceSharesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingInvitationResources
default ListPendingInvitationResourcesResponse listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException
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:
- Result of the ListPendingInvitationResources operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingInvitationResources
default ListPendingInvitationResourcesResponse listPendingInvitationResources(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaListPendingInvitationResourcesRequest.builder()- Parameters:
listPendingInvitationResourcesRequest- AConsumerthat will call methods onListPendingInvitationResourcesRequest.Builderto create a request.- Returns:
- Result of the ListPendingInvitationResources operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingInvitationResourcesPaginator
default ListPendingInvitationResourcesIterable listPendingInvitationResourcesPaginator(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client .listPendingInvitationResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPendingInvitationResourcesPaginator
default ListPendingInvitationResourcesIterable listPendingInvitationResourcesPaginator(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client .listPendingInvitationResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPendingInvitationResourcesRequest.builder()- Parameters:
listPendingInvitationResourcesRequest- AConsumerthat will call methods onListPendingInvitationResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionAssociations
default ListPermissionAssociationsResponse listPermissionAssociations(ListPermissionAssociationsRequest listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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:
- Result of the ListPermissionAssociations operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionAssociations
default ListPermissionAssociationsResponse listPermissionAssociations(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaListPermissionAssociationsRequest.builder()- Parameters:
listPermissionAssociationsRequest- AConsumerthat will call methods onListPermissionAssociationsRequest.Builderto create a request.- Returns:
- Result of the ListPermissionAssociations operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionAssociationsPaginator
default ListPermissionAssociationsIterable listPermissionAssociationsPaginator(ListPermissionAssociationsRequest listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client .listPermissionAssociationsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionAssociationsPaginator
default ListPermissionAssociationsIterable listPermissionAssociationsPaginator(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client .listPermissionAssociationsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPermissionAssociationsRequest.builder()- Parameters:
listPermissionAssociationsRequest- AConsumerthat will call methods onListPermissionAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionVersions
default ListPermissionVersionsResponse listPermissionVersions(ListPermissionVersionsRequest listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
Lists the available versions of the specified RAM permission.
- Parameters:
listPermissionVersionsRequest-- Returns:
- Result of the ListPermissionVersions operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionVersions
default ListPermissionVersionsResponse listPermissionVersions(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
Lists the available versions of the specified RAM permission.
This is a convenience which creates an instance of the
ListPermissionVersionsRequest.Builderavoiding the need to create one manually viaListPermissionVersionsRequest.builder()- Parameters:
listPermissionVersionsRequest- AConsumerthat will call methods onListPermissionVersionsRequest.Builderto create a request.- Returns:
- Result of the ListPermissionVersions operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionVersionsPaginator
default ListPermissionVersionsIterable listPermissionVersionsPaginator(ListPermissionVersionsRequest listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client .listPermissionVersionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionVersionsPaginator
default ListPermissionVersionsIterable listPermissionVersionsPaginator(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client .listPermissionVersionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPermissionVersionsRequest.builder()- Parameters:
listPermissionVersionsRequest- AConsumerthat will call methods onListPermissionVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissions
default ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Retrieves a list of available RAM permissions that you can use for the supported resource types.
- Parameters:
listPermissionsRequest-- Returns:
- Result of the ListPermissions operation returned by the service.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissions
default ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- Result of the ListPermissions operation returned by the service.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPermissionsRequest.builder()- Parameters:
listPermissionsRequest- AConsumerthat will call methods onListPermissionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipals
default ListPrincipalsResponse listPrincipals(ListPrincipalsRequest listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the principals that you are sharing resources with or that are sharing resources with you.
- Parameters:
listPrincipalsRequest-- Returns:
- Result of the ListPrincipals operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipals
default ListPrincipalsResponse listPrincipals(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaListPrincipalsRequest.builder()- Parameters:
listPrincipalsRequest- AConsumerthat will call methods onListPrincipalsRequest.Builderto create a request.- Returns:
- Result of the ListPrincipals operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipalsPaginator
default ListPrincipalsIterable listPrincipalsPaginator(ListPrincipalsRequest listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPrincipalsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrincipalsPaginator
default ListPrincipalsIterable listPrincipalsPaginator(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPrincipalsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListPrincipalsRequest.builder()- Parameters:
listPrincipalsRequest- AConsumerthat will call methods onListPrincipalsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listReplacePermissionAssociationsWork
default ListReplacePermissionAssociationsWorkResponse listReplacePermissionAssociationsWork(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
- Parameters:
listReplacePermissionAssociationsWorkRequest-- Returns:
- Result of the ListReplacePermissionAssociationsWork operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listReplacePermissionAssociationsWork
default ListReplacePermissionAssociationsWorkResponse listReplacePermissionAssociationsWork(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaListReplacePermissionAssociationsWorkRequest.builder()- Parameters:
listReplacePermissionAssociationsWorkRequest- AConsumerthat will call methods onListReplacePermissionAssociationsWorkRequest.Builderto create a request.- Returns:
- Result of the ListReplacePermissionAssociationsWork operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listReplacePermissionAssociationsWorkPaginator
default ListReplacePermissionAssociationsWorkIterable listReplacePermissionAssociationsWorkPaginator(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
This is a variant of
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client .listReplacePermissionAssociationsWorkPaginator(request); for (software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listReplacePermissionAssociationsWorkPaginator
default ListReplacePermissionAssociationsWorkIterable listReplacePermissionAssociationsWorkPaginator(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException
This is a variant of
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client .listReplacePermissionAssociationsWorkPaginator(request); for (software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListReplacePermissionAssociationsWorkRequest.builder()- Parameters:
listReplacePermissionAssociationsWorkRequest- AConsumerthat will call methods onListReplacePermissionAssociationsWorkRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceSharePermissions
default ListResourceSharePermissionsResponse listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Lists the RAM permissions that are associated with a resource share.
- Parameters:
listResourceSharePermissionsRequest-- Returns:
- Result of the ListResourceSharePermissions operation returned by the service.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceSharePermissions
default ListResourceSharePermissionsResponse listResourceSharePermissions(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Lists the RAM permissions that are associated with a resource share.
This is a convenience which creates an instance of the
ListResourceSharePermissionsRequest.Builderavoiding the need to create one manually viaListResourceSharePermissionsRequest.builder()- Parameters:
listResourceSharePermissionsRequest- AConsumerthat will call methods onListResourceSharePermissionsRequest.Builderto create a request.- Returns:
- Result of the ListResourceSharePermissions operation returned by the service.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceSharePermissionsPaginator
default ListResourceSharePermissionsIterable listResourceSharePermissionsPaginator(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
This is a variant of
listResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListResourceSharePermissionsIterable responses = client.listResourceSharePermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListResourceSharePermissionsIterable responses = client .listResourceSharePermissionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourceSharePermissionsIterable responses = client.listResourceSharePermissionsPaginator(request); responses.iterator().forEachRemaining(....);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
listResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)operation.- Parameters:
listResourceSharePermissionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceSharePermissionsPaginator
default ListResourceSharePermissionsIterable listResourceSharePermissionsPaginator(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
This is a variant of
listResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListResourceSharePermissionsIterable responses = client.listResourceSharePermissionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListResourceSharePermissionsIterable responses = client .listResourceSharePermissionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourceSharePermissionsIterable responses = client.listResourceSharePermissionsPaginator(request); responses.iterator().forEachRemaining(....);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
listResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)operation.
This is a convenience which creates an instance of the
ListResourceSharePermissionsRequest.Builderavoiding the need to create one manually viaListResourceSharePermissionsRequest.builder()- Parameters:
listResourceSharePermissionsRequest- AConsumerthat will call methods onListResourceSharePermissionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidParameterException- The operation failed because a parameter you specified isn't valid.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceTypes
default ListResourceTypesResponse listResourceTypes(ListResourceTypesRequest listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the resource types that can be shared by RAM.
- Parameters:
listResourceTypesRequest-- Returns:
- Result of the ListResourceTypes operation returned by the service.
- Throws:
InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceTypes
default ListResourceTypesResponse listResourceTypes(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the resource types that can be shared by RAM.
This is a convenience which creates an instance of the
ListResourceTypesRequest.Builderavoiding the need to create one manually viaListResourceTypesRequest.builder()- Parameters:
listResourceTypesRequest- AConsumerthat will call methods onListResourceTypesRequest.Builderto create a request.- Returns:
- Result of the ListResourceTypes operation returned by the service.
- Throws:
InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceTypesPaginator
default ListResourceTypesIterable listResourceTypesPaginator(ListResourceTypesRequest listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client .listResourceTypesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourceTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourceTypesPaginator
default ListResourceTypesIterable listResourceTypesPaginator(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client .listResourceTypesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourceTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListResourceTypesRequest.builder()- Parameters:
listResourceTypesRequest- AConsumerthat will call methods onListResourceTypesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- The operation failed because the specified value forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResources
default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the resources that you added to a resource share or the resources that are shared with you.
- Parameters:
listResourcesRequest-- Returns:
- Result of the ListResources operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResources
default ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- Result of the ListResources operation returned by the service.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
This is a variant of
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListResourcesRequest.builder()- Parameters:
listResourcesRequest- AConsumerthat will call methods onListResourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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 forNextTokenisn't valid. You must specify a value you received in theNextTokenresponse 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.AwsServiceException- See Also:
- AWS API Documentation
-
promotePermissionCreatedFromPolicy
default PromotePermissionCreatedFromPolicyResponse promotePermissionCreatedFromPolicy(PromotePermissionCreatedFromPolicyRequest promotePermissionCreatedFromPolicyRequest) throws MalformedArnException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet=CREATED_FROM_POLICYwith 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_POLICYpolicy isn't deleted, and resource shares using that original policy aren't automatically updated. -
You can't modify a
CREATED_FROM_POLICYresource 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 promotedSTANDARDresource share. -
After you promote a resource share, if the original
CREATED_FROM_POLICYmanaged permission has no other associations to A resource share, then RAM automatically deletes it.
- Parameters:
promotePermissionCreatedFromPolicyRequest-- Returns:
- Result of the PromotePermissionCreatedFromPolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
promotePermissionCreatedFromPolicy
default PromotePermissionCreatedFromPolicyResponse promotePermissionCreatedFromPolicy(Consumer<PromotePermissionCreatedFromPolicyRequest.Builder> promotePermissionCreatedFromPolicyRequest) throws MalformedArnException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet=CREATED_FROM_POLICYwith 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_POLICYpolicy isn't deleted, and resource shares using that original policy aren't automatically updated. -
You can't modify a
CREATED_FROM_POLICYresource 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 promotedSTANDARDresource share. -
After you promote a resource share, if the original
CREATED_FROM_POLICYmanaged 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.Builderavoiding the need to create one manually viaPromotePermissionCreatedFromPolicyRequest.builder()- Parameters:
promotePermissionCreatedFromPolicyRequest- AConsumerthat will call methods onPromotePermissionCreatedFromPolicyRequest.Builderto create a request.- Returns:
- Result of the PromotePermissionCreatedFromPolicy operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
promoteResourceShareCreatedFromPolicy
default PromoteResourceShareCreatedFromPolicyResponse promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest) throws MalformedArnException, ResourceShareLimitExceededException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, InvalidStateTransitionException, UnmatchedPolicyPermissionException, AwsServiceException, SdkClientException, RamException
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet=CREATED_FROM_POLICYwith a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.This operation promotes the resource share to a
STANDARDresource share that is fully manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that you have an appropriate customer managed permission that can be associated with this resource share after its is promoted. If this operation can't find a managed permission that exactly matches the existing
CREATED_FROM_POLICYpermission, then this operation fails.- Parameters:
promoteResourceShareCreatedFromPolicyRequest-- Returns:
- Result of the PromoteResourceShareCreatedFromPolicy operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.InvalidParameterException- The operation failed because a parameter you specified isn't valid.MissingRequiredParameterException- The operation failed because a required input parameter is missing.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.UnmatchedPolicyPermissionException- There isn't an existing managed permission defined in RAM that has the same IAM permissions as the resource-based policy attached to the resource. You should first run PromotePermissionCreatedFromPolicy to create that managed permission.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.AwsServiceException- See Also:
- AWS API Documentation
-
promoteResourceShareCreatedFromPolicy
default PromoteResourceShareCreatedFromPolicyResponse promoteResourceShareCreatedFromPolicy(Consumer<PromoteResourceShareCreatedFromPolicyRequest.Builder> promoteResourceShareCreatedFromPolicyRequest) throws MalformedArnException, ResourceShareLimitExceededException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, InvalidStateTransitionException, UnmatchedPolicyPermissionException, AwsServiceException, SdkClientException, RamException
When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet=CREATED_FROM_POLICYwith a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.This operation promotes the resource share to a
STANDARDresource share that is fully manageable in RAM. When you promote a resource share, you can then manage the resource share in RAM and it becomes visible to all of the principals you shared it with.Before you perform this operation, you should first run PromotePermissionCreatedFromPolicyto ensure that you have an appropriate customer managed permission that can be associated with this resource share after its is promoted. If this operation can't find a managed permission that exactly matches the existing
CREATED_FROM_POLICYpermission, then this operation fails.
This is a convenience which creates an instance of the
PromoteResourceShareCreatedFromPolicyRequest.Builderavoiding the need to create one manually viaPromoteResourceShareCreatedFromPolicyRequest.builder()- Parameters:
promoteResourceShareCreatedFromPolicyRequest- AConsumerthat will call methods onPromoteResourceShareCreatedFromPolicyRequest.Builderto create a request.- Returns:
- Result of the PromoteResourceShareCreatedFromPolicy operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.ResourceShareLimitExceededException- The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the RAM page in the Service Quotas console.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.InvalidParameterException- The operation failed because a parameter you specified isn't valid.MissingRequiredParameterException- The operation failed because a required input parameter is missing.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.UnknownResourceException- The operation failed because a specified resource couldn't be found.InvalidStateTransitionException- The operation failed because the requested operation isn't valid for the resource share in its current state.UnmatchedPolicyPermissionException- There isn't an existing managed permission defined in RAM that has the same IAM permissions as the resource-based policy attached to the resource. You should first run PromotePermissionCreatedFromPolicy to create that managed permission.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.AwsServiceException- See Also:
- AWS API Documentation
-
rejectResourceShareInvitation
default RejectResourceShareInvitationResponse rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest) throws MalformedArnException, OperationNotPermittedException, ResourceShareInvitationArnNotFoundException, ResourceShareInvitationAlreadyAcceptedException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, ServerInternalException, ServiceUnavailableException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
Rejects an invitation to a resource share from another Amazon Web Services account.
- Parameters:
rejectResourceShareInvitationRequest-- Returns:
- Result of the RejectResourceShareInvitation operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException- The operation failed because the specified invitation was already accepted.ResourceShareInvitationAlreadyRejectedException- The operation failed because the specified invitation was already rejected.ResourceShareInvitationExpiredException- The operation failed because the specified invitation is past its expiration date and time.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.InvalidClientTokenException- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.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.AwsServiceException- See Also:
- AWS API Documentation
-
rejectResourceShareInvitation
default RejectResourceShareInvitationResponse rejectResourceShareInvitation(Consumer<RejectResourceShareInvitationRequest.Builder> rejectResourceShareInvitationRequest) throws MalformedArnException, OperationNotPermittedException, ResourceShareInvitationArnNotFoundException, ResourceShareInvitationAlreadyAcceptedException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, ServerInternalException, ServiceUnavailableException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
Rejects an invitation to a resource share from another Amazon Web Services account.
This is a convenience which creates an instance of the
RejectResourceShareInvitationRequest.Builderavoiding the need to create one manually viaRejectResourceShareInvitationRequest.builder()- Parameters:
rejectResourceShareInvitationRequest- AConsumerthat will call methods onRejectResourceShareInvitationRequest.Builderto create a request.- Returns:
- Result of the RejectResourceShareInvitation operation returned by the service.
- Throws:
MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ResourceShareInvitationArnNotFoundException- The operation failed because the specified Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException- The operation failed because the specified invitation was already accepted.ResourceShareInvitationAlreadyRejectedException- The operation failed because the specified invitation was already rejected.ResourceShareInvitationExpiredException- The operation failed because the specified invitation is past its expiration date and time.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.InvalidClientTokenException- The operation failed because the specified client token isn't valid.IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.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.AwsServiceException- See Also:
- AWS API Documentation
-
replacePermissionAssociations
default ReplacePermissionAssociationsResponse replacePermissionAssociations(ReplacePermissionAssociationsRequest replacePermissionAssociationsRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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
fromPermissionArnandtoPermissionArnparameters.You can use the optional
fromPermissionVersionparameter 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:
- Result of the ReplacePermissionAssociations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
replacePermissionAssociations
default ReplacePermissionAssociationsResponse replacePermissionAssociations(Consumer<ReplacePermissionAssociationsRequest.Builder> replacePermissionAssociationsRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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
fromPermissionArnandtoPermissionArnparameters.You can use the optional
fromPermissionVersionparameter 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.Builderavoiding the need to create one manually viaReplacePermissionAssociationsRequest.builder()- Parameters:
replacePermissionAssociationsRequest- AConsumerthat will call methods onReplacePermissionAssociationsRequest.Builderto create a request.- Returns:
- Result of the ReplacePermissionAssociations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
setDefaultPermissionVersion
default SetDefaultPermissionVersionResponse setDefaultPermissionVersion(SetDefaultPermissionVersionRequest setDefaultPermissionVersionRequest) throws InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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:
- Result of the SetDefaultPermissionVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
setDefaultPermissionVersion
default SetDefaultPermissionVersionResponse setDefaultPermissionVersion(Consumer<SetDefaultPermissionVersionRequest.Builder> setDefaultPermissionVersionRequest) throws InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaSetDefaultPermissionVersionRequest.builder()- Parameters:
setDefaultPermissionVersionRequest- AConsumerthat will call methods onSetDefaultPermissionVersionRequest.Builderto create a request.- Returns:
- Result of the SetDefaultPermissionVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, TagLimitExceededException, ResourceArnNotFoundException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, TagLimitExceededException, ResourceArnNotFoundException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws UnknownResourceException, InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Removes the specified tag key and value pairs from the specified resource share or managed permission.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws UnknownResourceException, InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateResourceShare
default UpdateResourceShareResponse updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest) throws IdempotentParameterMismatchException, MissingRequiredParameterException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Modifies some of the properties of the specified resource share.
- Parameters:
updateResourceShareRequest-- Returns:
- Result of the UpdateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.MissingRequiredParameterException- The operation failed because a required input parameter is missing.UnknownResourceException- The operation failed because a specified resource couldn't be found.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateResourceShare
default UpdateResourceShareResponse updateResourceShare(Consumer<UpdateResourceShareRequest.Builder> updateResourceShareRequest) throws IdempotentParameterMismatchException, MissingRequiredParameterException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Modifies some of the properties of the specified resource share.
This is a convenience which creates an instance of the
UpdateResourceShareRequest.Builderavoiding the need to create one manually viaUpdateResourceShareRequest.builder()- Parameters:
updateResourceShareRequest- AConsumerthat will call methods onUpdateResourceShareRequest.Builderto create a request.- Returns:
- Result of the UpdateResourceShare operation returned by the service.
- Throws:
IdempotentParameterMismatchException- The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.MissingRequiredParameterException- The operation failed because a required input parameter is missing.UnknownResourceException- The operation failed because a specified resource couldn't be found.MalformedArnException- The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.InvalidClientTokenException- The operation failed because the specified client token isn't valid.InvalidParameterException- The operation failed because a parameter you specified isn't valid.OperationNotPermittedException- The operation failed because the requested operation isn't permitted.ServerInternalException- The operation failed because the service could not respond to the request due to an internal problem. Try again later.ServiceUnavailableException- The operation failed because the service isn't available. Try again later.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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static RamClient create()
Create aRamClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static RamClientBuilder builder()
Create a builder that can be used to configure and create aRamClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default RamServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-