@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface RamClient extends SdkClient
builder() method.
Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations.
For more information, see the AWS Resource Access Manager User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AcceptResourceShareInvitationResponse |
acceptResourceShareInvitation(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest)
Accepts an invitation to a resource share from another AWS account.
|
default AcceptResourceShareInvitationResponse |
acceptResourceShareInvitation(Consumer<AcceptResourceShareInvitationRequest.Builder> acceptResourceShareInvitationRequest)
Accepts an invitation to a resource share from another AWS account.
|
default AssociateResourceShareResponse |
associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest)
Associates the specified resource share with the specified principals and resources.
|
default AssociateResourceShareResponse |
associateResourceShare(Consumer<AssociateResourceShareRequest.Builder> associateResourceShareRequest)
Associates the specified resource share with the specified principals and resources.
|
default AssociateResourceSharePermissionResponse |
associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest)
Associates a permission with a resource share.
|
default AssociateResourceSharePermissionResponse |
associateResourceSharePermission(Consumer<AssociateResourceSharePermissionRequest.Builder> associateResourceSharePermissionRequest)
Associates a permission with a resource share.
|
static RamClientBuilder |
builder()
Create a builder that can be used to configure and create a
RamClient. |
static RamClient |
create()
Create a
RamClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateResourceShareResponse |
createResourceShare(Consumer<CreateResourceShareRequest.Builder> createResourceShareRequest)
Creates a resource share.
|
default CreateResourceShareResponse |
createResourceShare(CreateResourceShareRequest createResourceShareRequest)
Creates a resource share.
|
default DeleteResourceShareResponse |
deleteResourceShare(Consumer<DeleteResourceShareRequest.Builder> deleteResourceShareRequest)
Deletes the specified resource share.
|
default DeleteResourceShareResponse |
deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest)
Deletes the specified resource share.
|
default DisassociateResourceShareResponse |
disassociateResourceShare(Consumer<DisassociateResourceShareRequest.Builder> disassociateResourceShareRequest)
Disassociates the specified principals or resources from the specified resource share.
|
default DisassociateResourceShareResponse |
disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest)
Disassociates the specified principals or resources from the specified resource share.
|
default DisassociateResourceSharePermissionResponse |
disassociateResourceSharePermission(Consumer<DisassociateResourceSharePermissionRequest.Builder> disassociateResourceSharePermissionRequest)
Disassociates an AWS RAM permission from a resource share.
|
default DisassociateResourceSharePermissionResponse |
disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest)
Disassociates an AWS RAM permission from a resource share.
|
default EnableSharingWithAwsOrganizationResponse |
enableSharingWithAwsOrganization()
Enables resource sharing within your AWS Organization.
|
default EnableSharingWithAwsOrganizationResponse |
enableSharingWithAwsOrganization(Consumer<EnableSharingWithAwsOrganizationRequest.Builder> enableSharingWithAwsOrganizationRequest)
Enables resource sharing within your AWS Organization.
|
default EnableSharingWithAwsOrganizationResponse |
enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest)
Enables resource sharing within your AWS Organization.
|
default GetPermissionResponse |
getPermission(Consumer<GetPermissionRequest.Builder> getPermissionRequest)
Gets the contents of an AWS RAM permission in JSON format.
|
default GetPermissionResponse |
getPermission(GetPermissionRequest getPermissionRequest)
Gets the contents of an AWS RAM permission in JSON format.
|
default GetResourcePoliciesResponse |
getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)
Gets the policies for the specified resources that you own and have shared.
|
default GetResourcePoliciesResponse |
getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Gets the policies for the specified resources that you own and have shared.
|
default GetResourcePoliciesIterable |
getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest)
Gets the policies for the specified resources that you own and have shared.
|
default GetResourcePoliciesIterable |
getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest)
Gets the policies for the specified resources that you own and have shared.
|
default GetResourceShareAssociationsResponse |
getResourceShareAssociations(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest)
Gets the resources or principals for the resource shares that you own.
|
default GetResourceShareAssociationsResponse |
getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest)
Gets the resources or principals for the resource shares that you own.
|
default GetResourceShareAssociationsIterable |
getResourceShareAssociationsPaginator(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest)
Gets the resources or principals for the resource shares that you own.
|
default GetResourceShareAssociationsIterable |
getResourceShareAssociationsPaginator(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest)
Gets the resources or principals for the resource shares that you own.
|
default GetResourceShareInvitationsResponse |
getResourceShareInvitations()
Gets the invitations for resource sharing that you've received.
|
default GetResourceShareInvitationsResponse |
getResourceShareInvitations(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest)
Gets the invitations for resource sharing that you've received.
|
default GetResourceShareInvitationsResponse |
getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest)
Gets the invitations for resource sharing that you've received.
|
default GetResourceShareInvitationsIterable |
getResourceShareInvitationsPaginator()
Gets the invitations for resource sharing that you've received.
|
default GetResourceShareInvitationsIterable |
getResourceShareInvitationsPaginator(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest)
Gets the invitations for resource sharing that you've received.
|
default GetResourceShareInvitationsIterable |
getResourceShareInvitationsPaginator(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest)
Gets the invitations for resource sharing that you've received.
|
default GetResourceSharesResponse |
getResourceShares(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest)
Gets the resource shares that you own or the resource shares that are shared with you.
|
default GetResourceSharesResponse |
getResourceShares(GetResourceSharesRequest getResourceSharesRequest)
Gets the resource shares that you own or the resource shares that are shared with you.
|
default GetResourceSharesIterable |
getResourceSharesPaginator(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest)
Gets the resource shares that you own or the resource shares that are shared with you.
|
default GetResourceSharesIterable |
getResourceSharesPaginator(GetResourceSharesRequest getResourceSharesRequest)
Gets the resource shares that you own or the resource shares that are shared with you.
|
default ListPendingInvitationResourcesResponse |
listPendingInvitationResources(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
|
default ListPendingInvitationResourcesResponse |
listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
|
default ListPendingInvitationResourcesIterable |
listPendingInvitationResourcesPaginator(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
|
default ListPendingInvitationResourcesIterable |
listPendingInvitationResourcesPaginator(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest)
Lists the resources in a resource share that is shared with you but that the invitation is still pending for.
|
default ListPermissionsResponse |
listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest)
Lists the AWS RAM permissions.
|
default ListPermissionsResponse |
listPermissions(ListPermissionsRequest listPermissionsRequest)
Lists the AWS RAM permissions.
|
default ListPrincipalsResponse |
listPrincipals(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest)
Lists the principals that you have shared resources with or that have shared resources with you.
|
default ListPrincipalsResponse |
listPrincipals(ListPrincipalsRequest listPrincipalsRequest)
Lists the principals that you have shared resources with or that have shared resources with you.
|
default ListPrincipalsIterable |
listPrincipalsPaginator(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest)
Lists the principals that you have shared resources with or that have shared resources with you.
|
default ListPrincipalsIterable |
listPrincipalsPaginator(ListPrincipalsRequest listPrincipalsRequest)
Lists the principals that you have shared resources with or that have shared resources with you.
|
default ListResourcesResponse |
listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources that you added to a resource shares or the resources that are shared with you.
|
default ListResourcesResponse |
listResources(ListResourcesRequest listResourcesRequest)
Lists the resources that you added to a resource shares or the resources that are shared with you.
|
default ListResourceSharePermissionsResponse |
listResourceSharePermissions(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest)
Lists the AWS RAM permissions that are associated with a resource share.
|
default ListResourceSharePermissionsResponse |
listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest)
Lists the AWS RAM permissions that are associated with a resource share.
|
default ListResourcesIterable |
listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest)
Lists the resources that you added to a resource shares or the resources that are shared with you.
|
default ListResourcesIterable |
listResourcesPaginator(ListResourcesRequest listResourcesRequest)
Lists the resources that you added to a resource shares or the resources that are shared with you.
|
default ListResourceTypesResponse |
listResourceTypes(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest)
Lists the shareable resource types supported by AWS RAM.
|
default ListResourceTypesResponse |
listResourceTypes(ListResourceTypesRequest listResourceTypesRequest)
Lists the shareable resource types supported by AWS RAM.
|
default PromoteResourceShareCreatedFromPolicyResponse |
promoteResourceShareCreatedFromPolicy(Consumer<PromoteResourceShareCreatedFromPolicyRequest.Builder> promoteResourceShareCreatedFromPolicyRequest)
Resource shares that were created by attaching a policy to a resource are visible only to the resource share
owner, and the resource share cannot be modified in AWS RAM.
|
default PromoteResourceShareCreatedFromPolicyResponse |
promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest)
Resource shares that were created by attaching a policy to a resource are visible only to the resource share
owner, and the resource share cannot be modified in AWS RAM.
|
default RejectResourceShareInvitationResponse |
rejectResourceShareInvitation(Consumer<RejectResourceShareInvitationRequest.Builder> rejectResourceShareInvitationRequest)
Rejects an invitation to a resource share from another AWS account.
|
default RejectResourceShareInvitationResponse |
rejectResourceShareInvitation(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest)
Rejects an invitation to a resource share from another AWS account.
|
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds the specified tags to the specified resource share that you own.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource share that you own.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tags from the specified resource share that you own.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tags from the specified resource share that you own.
|
default UpdateResourceShareResponse |
updateResourceShare(Consumer<UpdateResourceShareRequest.Builder> updateResourceShareRequest)
Updates the specified resource share that you own.
|
default UpdateResourceShareResponse |
updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest)
Updates the specified resource share that you own.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static RamClient create()
RamClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static RamClientBuilder builder()
RamClient.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 AWS account.
acceptResourceShareInvitationRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.OperationNotPermittedException - The requested operation is not permitted.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException - The invitation was already accepted.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.InvalidClientTokenException - A client token is not valid.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.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.AwsServiceExceptiondefault 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 AWS account.
This is a convenience which creates an instance of the AcceptResourceShareInvitationRequest.Builder
avoiding the need to create one manually via AcceptResourceShareInvitationRequest.builder()
acceptResourceShareInvitationRequest - A Consumer that will call methods on AcceptResourceShareInvitationRequest.Builder to
create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.OperationNotPermittedException - The requested operation is not permitted.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException - The invitation was already accepted.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.InvalidClientTokenException - A client token is not valid.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.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.AwsServiceExceptiondefault AssociateResourceShareResponse associateResourceShare(AssociateResourceShareRequest associateResourceShareRequest) throws IdempotentParameterMismatchException, UnknownResourceException, InvalidStateTransitionException, ResourceShareLimitExceededException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Associates the specified resource share with the specified principals and resources.
associateResourceShareRequest - IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.UnknownResourceException - A specified resource was not found.InvalidStateTransitionException - The requested state transition is not valid.ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidStateTransitionException - The requested state transition is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.UnknownResourceException - A specified resource was not 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.AwsServiceExceptiondefault AssociateResourceShareResponse associateResourceShare(Consumer<AssociateResourceShareRequest.Builder> associateResourceShareRequest) throws IdempotentParameterMismatchException, UnknownResourceException, InvalidStateTransitionException, ResourceShareLimitExceededException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Associates the specified resource share with the specified principals and resources.
This is a convenience which creates an instance of the AssociateResourceShareRequest.Builder avoiding the
need to create one manually via AssociateResourceShareRequest.builder()
associateResourceShareRequest - A Consumer that will call methods on AssociateResourceShareRequest.Builder to create a
request.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.UnknownResourceException - A specified resource was not found.InvalidStateTransitionException - The requested state transition is not valid.ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidStateTransitionException - The requested state transition is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.UnknownResourceException - A specified resource was not 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.AwsServiceExceptiondefault AssociateResourceSharePermissionResponse associateResourceSharePermission(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Associates a permission with a resource share.
associateResourceSharePermissionRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidParameterException - A parameter is not valid.InvalidClientTokenException - A client token is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault AssociateResourceSharePermissionResponse associateResourceSharePermission(Consumer<AssociateResourceSharePermissionRequest.Builder> associateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Associates a permission with a resource share.
This is a convenience which creates an instance of the AssociateResourceSharePermissionRequest.Builder
avoiding the need to create one manually via AssociateResourceSharePermissionRequest.builder()
associateResourceSharePermissionRequest - A Consumer that will call methods on AssociateResourceSharePermissionRequest.Builder to
create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidParameterException - A parameter is not valid.InvalidClientTokenException - A client token is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault CreateResourceShareResponse createResourceShare(CreateResourceShareRequest createResourceShareRequest) throws IdempotentParameterMismatchException, InvalidStateTransitionException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ResourceShareLimitExceededException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Creates a resource share.
createResourceShareRequest - IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.InvalidStateTransitionException - The requested state transition is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.TagPolicyViolationException - The specified tag is a reserved word and cannot be used.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault CreateResourceShareResponse createResourceShare(Consumer<CreateResourceShareRequest.Builder> createResourceShareRequest) throws IdempotentParameterMismatchException, InvalidStateTransitionException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ResourceShareLimitExceededException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Creates a resource share.
This is a convenience which creates an instance of the CreateResourceShareRequest.Builder avoiding the
need to create one manually via CreateResourceShareRequest.builder()
createResourceShareRequest - A Consumer that will call methods on CreateResourceShareRequest.Builder to create a
request.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.InvalidStateTransitionException - The requested state transition is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.TagPolicyViolationException - The specified tag is a reserved word and cannot be used.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault DeleteResourceShareResponse deleteResourceShare(DeleteResourceShareRequest deleteResourceShareRequest) throws OperationNotPermittedException, IdempotentParameterMismatchException, InvalidStateTransitionException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Deletes the specified resource share.
deleteResourceShareRequest - OperationNotPermittedException - The requested operation is not permitted.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.InvalidStateTransitionException - The requested state transition is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault 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 is a convenience which creates an instance of the DeleteResourceShareRequest.Builder avoiding the
need to create one manually via DeleteResourceShareRequest.builder()
deleteResourceShareRequest - A Consumer that will call methods on DeleteResourceShareRequest.Builder to create a
request.OperationNotPermittedException - The requested operation is not permitted.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.InvalidStateTransitionException - The requested state transition is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault DisassociateResourceShareResponse disassociateResourceShare(DisassociateResourceShareRequest disassociateResourceShareRequest) throws IdempotentParameterMismatchException, ResourceShareLimitExceededException, MalformedArnException, InvalidStateTransitionException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
Disassociates the specified principals or resources from the specified resource share.
disassociateResourceShareRequest - IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidStateTransitionException - The requested state transition is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.UnknownResourceException - A specified resource was not 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.AwsServiceExceptiondefault DisassociateResourceShareResponse disassociateResourceShare(Consumer<DisassociateResourceShareRequest.Builder> disassociateResourceShareRequest) throws IdempotentParameterMismatchException, ResourceShareLimitExceededException, MalformedArnException, InvalidStateTransitionException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
Disassociates the specified principals or resources from the specified resource share.
This is a convenience which creates an instance of the DisassociateResourceShareRequest.Builder avoiding
the need to create one manually via DisassociateResourceShareRequest.builder()
disassociateResourceShareRequest - A Consumer that will call methods on DisassociateResourceShareRequest.Builder to create a
request.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.ResourceShareLimitExceededException - The requested resource share exceeds the limit for your account.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidStateTransitionException - The requested state transition is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.UnknownResourceException - A specified resource was not 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.AwsServiceExceptiondefault DisassociateResourceSharePermissionResponse disassociateResourceSharePermission(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Disassociates an AWS RAM permission from a resource share.
disassociateResourceSharePermissionRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidParameterException - A parameter is not valid.InvalidClientTokenException - A client token is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault DisassociateResourceSharePermissionResponse disassociateResourceSharePermission(Consumer<DisassociateResourceSharePermissionRequest.Builder> disassociateResourceSharePermissionRequest) throws MalformedArnException, UnknownResourceException, InvalidParameterException, InvalidClientTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Disassociates an AWS RAM permission from a resource share.
This is a convenience which creates an instance of the DisassociateResourceSharePermissionRequest.Builder
avoiding the need to create one manually via DisassociateResourceSharePermissionRequest.builder()
disassociateResourceSharePermissionRequest - A Consumer that will call methods on DisassociateResourceSharePermissionRequest.Builder to
create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidParameterException - A parameter is not valid.InvalidClientTokenException - A client token is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization() throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Enables resource sharing within your AWS Organization.
The caller must be the master account for the AWS Organization.
OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptionenableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest),
AWS API Documentationdefault EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Enables resource sharing within your AWS Organization.
The caller must be the master account for the AWS Organization.
enableSharingWithAwsOrganizationRequest - OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization(Consumer<EnableSharingWithAwsOrganizationRequest.Builder> enableSharingWithAwsOrganizationRequest) throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Enables resource sharing within your AWS Organization.
The caller must be the master account for the AWS Organization.
This is a convenience which creates an instance of the EnableSharingWithAwsOrganizationRequest.Builder
avoiding the need to create one manually via EnableSharingWithAwsOrganizationRequest.builder()
enableSharingWithAwsOrganizationRequest - A Consumer that will call methods on EnableSharingWithAwsOrganizationRequest.Builder to
create a request.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetPermissionResponse getPermission(GetPermissionRequest getPermissionRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Gets the contents of an AWS RAM permission in JSON format.
getPermissionRequest - InvalidParameterException - A parameter is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault GetPermissionResponse getPermission(Consumer<GetPermissionRequest.Builder> getPermissionRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Gets the contents of an AWS RAM permission in JSON format.
This is a convenience which creates an instance of the GetPermissionRequest.Builder avoiding the need to
create one manually via GetPermissionRequest.builder()
getPermissionRequest - A Consumer that will call methods on GetPermissionRequest.Builder to create a request.InvalidParameterException - A parameter is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault GetResourcePoliciesResponse getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the policies for the specified resources that you own and have shared.
getResourcePoliciesRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ResourceArnNotFoundException - An Amazon Resource Name (ARN) was not found.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourcePoliciesResponse getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the policies for the specified resources that you own and have shared.
This is a convenience which creates an instance of the GetResourcePoliciesRequest.Builder avoiding the
need to create one manually via GetResourcePoliciesRequest.builder()
getResourcePoliciesRequest - A Consumer that will call methods on GetResourcePoliciesRequest.Builder to create a
request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ResourceArnNotFoundException - An Amazon Resource Name (ARN) was not found.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourcePoliciesIterable getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the policies for the specified resources that you own and have shared.
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
software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getResourcePoliciesRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ResourceArnNotFoundException - An Amazon Resource Name (ARN) was not found.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourcePoliciesIterable getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the policies for the specified resources that you own and have shared.
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
software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via GetResourcePoliciesRequest.builder()
getResourcePoliciesRequest - A Consumer that will call methods on GetResourcePoliciesRequest.Builder to create a
request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ResourceArnNotFoundException - An Amazon Resource Name (ARN) was not found.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareAssociationsResponse getResourceShareAssociations(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resources or principals for the resource shares that you own.
getResourceShareAssociationsRequest - UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareAssociationsResponse getResourceShareAssociations(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resources or principals for the resource shares that you own.
This is a convenience which creates an instance of the GetResourceShareAssociationsRequest.Builder
avoiding the need to create one manually via GetResourceShareAssociationsRequest.builder()
getResourceShareAssociationsRequest - A Consumer that will call methods on GetResourceShareAssociationsRequest.Builder to create
a request.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareAssociationsIterable getResourceShareAssociationsPaginator(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resources or principals for the resource shares that you own.
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
software.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client.getResourceShareAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getResourceShareAssociationsRequest - UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareAssociationsIterable getResourceShareAssociationsPaginator(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resources or principals for the resource shares that you own.
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
software.amazon.awssdk.services.ram.paginators.GetResourceShareAssociationsIterable responses = client.getResourceShareAssociationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via GetResourceShareAssociationsRequest.builder()
getResourceShareAssociationsRequest - A Consumer that will call methods on GetResourceShareAssociationsRequest.Builder to create
a request.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareInvitationsResponse getResourceShareInvitations() throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the invitations for resource sharing that you've received.
ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException - The specified value for MaxResults is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiongetResourceShareInvitations(GetResourceShareInvitationsRequest),
AWS API Documentationdefault GetResourceShareInvitationsResponse getResourceShareInvitations(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the invitations for resource sharing that you've received.
getResourceShareInvitationsRequest - ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException - The specified value for MaxResults is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareInvitationsResponse getResourceShareInvitations(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the invitations for resource sharing that you've received.
This is a convenience which creates an instance of the GetResourceShareInvitationsRequest.Builder
avoiding the need to create one manually via GetResourceShareInvitationsRequest.builder()
getResourceShareInvitationsRequest - A Consumer that will call methods on GetResourceShareInvitationsRequest.Builder to create
a request.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException - The specified value for MaxResults is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareInvitationsIterable getResourceShareInvitationsPaginator() throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the invitations for resource sharing that you've received.
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
software.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException - The specified value for MaxResults is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiongetResourceShareInvitationsPaginator(GetResourceShareInvitationsRequest),
AWS API Documentationdefault GetResourceShareInvitationsIterable getResourceShareInvitationsPaginator(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the invitations for resource sharing that you've received.
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
software.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getResourceShareInvitationsRequest - ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException - The specified value for MaxResults is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceShareInvitationsIterable getResourceShareInvitationsPaginator(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) throws ResourceShareInvitationArnNotFoundException, InvalidMaxResultsException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the invitations for resource sharing that you've received.
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
software.amazon.awssdk.services.ram.paginators.GetResourceShareInvitationsIterable responses = client.getResourceShareInvitationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via GetResourceShareInvitationsRequest.builder()
getResourceShareInvitationsRequest - A Consumer that will call methods on GetResourceShareInvitationsRequest.Builder to create
a request.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.InvalidMaxResultsException - The specified value for MaxResults is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceSharesResponse getResourceShares(GetResourceSharesRequest getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resource shares that you own or the resource shares that are shared with you.
getResourceSharesRequest - UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceSharesResponse getResourceShares(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resource shares that you own or the resource shares that are shared with you.
This is a convenience which creates an instance of the GetResourceSharesRequest.Builder avoiding the need
to create one manually via GetResourceSharesRequest.builder()
getResourceSharesRequest - A Consumer that will call methods on GetResourceSharesRequest.Builder to create a request.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceSharesIterable getResourceSharesPaginator(GetResourceSharesRequest getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resource shares that you own or the resource shares that are shared with you.
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
software.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client.getResourceSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getResourceSharesRequest - UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault GetResourceSharesIterable getResourceSharesPaginator(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) throws UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Gets the resource shares that you own or the resource shares that are shared with you.
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
software.amazon.awssdk.services.ram.paginators.GetResourceSharesIterable responses = client.getResourceSharesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via GetResourceSharesRequest.builder()
getResourceSharesRequest - A Consumer that will call methods on GetResourceSharesRequest.Builder to create a request.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault 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 that the invitation is still pending for.
listPendingInvitationResourcesRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.MissingRequiredParameterException - A required input parameter is missing.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.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.AwsServiceExceptiondefault 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 that the invitation is still pending for.
This is a convenience which creates an instance of the ListPendingInvitationResourcesRequest.Builder
avoiding the need to create one manually via ListPendingInvitationResourcesRequest.builder()
listPendingInvitationResourcesRequest - A Consumer that will call methods on ListPendingInvitationResourcesRequest.Builder to
create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.MissingRequiredParameterException - A required input parameter is missing.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.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.AwsServiceExceptiondefault ListPendingInvitationResourcesIterable listPendingInvitationResourcesPaginator(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 that the invitation is still pending for.
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
software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listPendingInvitationResourcesRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.MissingRequiredParameterException - A required input parameter is missing.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.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.AwsServiceExceptiondefault ListPendingInvitationResourcesIterable listPendingInvitationResourcesPaginator(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 that the invitation is still pending for.
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
software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via ListPendingInvitationResourcesRequest.builder()
listPendingInvitationResourcesRequest - A Consumer that will call methods on ListPendingInvitationResourcesRequest.Builder to
create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.MissingRequiredParameterException - A required input parameter is missing.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.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.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Lists the AWS RAM permissions.
listPermissionsRequest - InvalidParameterException - A parameter is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Lists the AWS RAM permissions.
This is a convenience which creates an instance of the ListPermissionsRequest.Builder avoiding the need
to create one manually via ListPermissionsRequest.builder()
listPermissionsRequest - A Consumer that will call methods on ListPermissionsRequest.Builder to create a request.InvalidParameterException - A parameter is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault ListPrincipalsResponse listPrincipals(ListPrincipalsRequest listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the principals that you have shared resources with or that have shared resources with you.
listPrincipalsRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListPrincipalsResponse listPrincipals(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the principals that you have shared resources with or that have shared resources with you.
This is a convenience which creates an instance of the ListPrincipalsRequest.Builder avoiding the need to
create one manually via ListPrincipalsRequest.builder()
listPrincipalsRequest - A Consumer that will call methods on ListPrincipalsRequest.Builder to create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListPrincipalsIterable listPrincipalsPaginator(ListPrincipalsRequest listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the principals that you have shared resources with or that have shared resources with you.
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
software.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listPrincipalsRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListPrincipalsIterable listPrincipalsPaginator(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the principals that you have shared resources with or that have shared resources with you.
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
software.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListPrincipalsRequest.builder()
listPrincipalsRequest - A Consumer that will call methods on ListPrincipalsRequest.Builder to create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListResourceSharePermissionsResponse listResourceSharePermissions(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Lists the AWS RAM permissions that are associated with a resource share.
listResourceSharePermissionsRequest - InvalidParameterException - A parameter is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault ListResourceSharePermissionsResponse listResourceSharePermissions(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException
Lists the AWS RAM permissions that are associated with a resource share.
This is a convenience which creates an instance of the ListResourceSharePermissionsRequest.Builder
avoiding the need to create one manually via ListResourceSharePermissionsRequest.builder()
listResourceSharePermissionsRequest - A Consumer that will call methods on ListResourceSharePermissionsRequest.Builder to create
a request.InvalidParameterException - A parameter is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.UnknownResourceException - A specified resource was not found.InvalidNextTokenException - The specified value for NextToken is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.OperationNotPermittedException - The requested operation is not 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.AwsServiceExceptiondefault ListResourceTypesResponse listResourceTypes(ListResourceTypesRequest listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the shareable resource types supported by AWS RAM.
listResourceTypesRequest - InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListResourceTypesResponse listResourceTypes(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the shareable resource types supported by AWS RAM.
This is a convenience which creates an instance of the ListResourceTypesRequest.Builder avoiding the need
to create one manually via ListResourceTypesRequest.builder()
listResourceTypesRequest - A Consumer that will call methods on ListResourceTypesRequest.Builder to create a request.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the resources that you added to a resource shares or the resources that are shared with you.
listResourcesRequest - InvalidResourceTypeException - The specified resource type is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault 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 shares or the resources that are shared with you.
This is a convenience which creates an instance of the ListResourcesRequest.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidResourceTypeException - The specified resource type is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the resources that you added to a resource shares or the resources that are shared with you.
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
software.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listResourcesRequest - InvalidResourceTypeException - The specified resource type is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Lists the resources that you added to a resource shares or the resources that are shared with you.
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
software.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListResourcesRequest.builder()
listResourcesRequest - A Consumer that will call methods on ListResourcesRequest.Builder to create a request.InvalidResourceTypeException - The specified resource type is not valid.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidNextTokenException - The specified value for NextToken is not valid.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault PromoteResourceShareCreatedFromPolicyResponse promoteResourceShareCreatedFromPolicy(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest) throws MalformedArnException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.
Use this API action to promote the resource share. When you promote the resource share, it becomes:
Visible to all principals that it is shared with.
Modifiable in AWS RAM.
promoteResourceShareCreatedFromPolicyRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.OperationNotPermittedException - The requested operation is not permitted.InvalidParameterException - A parameter is not valid.MissingRequiredParameterException - A required input parameter is missing.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.UnknownResourceException - A specified resource was not 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.AwsServiceExceptiondefault PromoteResourceShareCreatedFromPolicyResponse promoteResourceShareCreatedFromPolicy(Consumer<PromoteResourceShareCreatedFromPolicyRequest.Builder> promoteResourceShareCreatedFromPolicyRequest) throws MalformedArnException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException
Resource shares that were created by attaching a policy to a resource are visible only to the resource share owner, and the resource share cannot be modified in AWS RAM.
Use this API action to promote the resource share. When you promote the resource share, it becomes:
Visible to all principals that it is shared with.
Modifiable in AWS RAM.
This is a convenience which creates an instance of the
PromoteResourceShareCreatedFromPolicyRequest.Builder avoiding the need to create one manually via
PromoteResourceShareCreatedFromPolicyRequest.builder()
promoteResourceShareCreatedFromPolicyRequest - A Consumer that will call methods on PromoteResourceShareCreatedFromPolicyRequest.Builder
to create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.OperationNotPermittedException - The requested operation is not permitted.InvalidParameterException - A parameter is not valid.MissingRequiredParameterException - A required input parameter is missing.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.UnknownResourceException - A specified resource was not 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.AwsServiceExceptiondefault 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 AWS account.
rejectResourceShareInvitationRequest - MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.OperationNotPermittedException - The requested operation is not permitted.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException - The invitation was already accepted.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.InvalidClientTokenException - A client token is not valid.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.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.AwsServiceExceptiondefault 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 AWS account.
This is a convenience which creates an instance of the RejectResourceShareInvitationRequest.Builder
avoiding the need to create one manually via RejectResourceShareInvitationRequest.builder()
rejectResourceShareInvitationRequest - A Consumer that will call methods on RejectResourceShareInvitationRequest.Builder to
create a request.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.OperationNotPermittedException - The requested operation is not permitted.ResourceShareInvitationArnNotFoundException - The Amazon Resource Name (ARN) for an invitation was not found.ResourceShareInvitationAlreadyAcceptedException - The invitation was already accepted.ResourceShareInvitationAlreadyRejectedException - The invitation was already rejected.ResourceShareInvitationExpiredException - The invitation is expired.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.InvalidClientTokenException - A client token is not valid.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, MalformedArnException, TagLimitExceededException, ResourceArnNotFoundException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Adds the specified tags to the specified resource share that you own.
tagResourceRequest - InvalidParameterException - A parameter is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.TagLimitExceededException - The requested tags exceed the limit for your account.ResourceArnNotFoundException - An Amazon Resource Name (ARN) was not found.TagPolicyViolationException - The specified tag is a reserved word and cannot be used.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, MalformedArnException, TagLimitExceededException, ResourceArnNotFoundException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Adds the specified tags to the specified resource share that you own.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InvalidParameterException - A parameter is not valid.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.TagLimitExceededException - The requested tags exceed the limit for your account.ResourceArnNotFoundException - An Amazon Resource Name (ARN) was not found.TagPolicyViolationException - The specified tag is a reserved word and cannot be used.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Removes the specified tags from the specified resource share that you own.
untagResourceRequest - InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Removes the specified tags from the specified resource share that you own.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InvalidParameterException - A parameter is not valid.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault UpdateResourceShareResponse updateResourceShare(UpdateResourceShareRequest updateResourceShareRequest) throws IdempotentParameterMismatchException, MissingRequiredParameterException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Updates the specified resource share that you own.
updateResourceShareRequest - IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.MissingRequiredParameterException - A required input parameter is missing.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptiondefault UpdateResourceShareResponse updateResourceShare(Consumer<UpdateResourceShareRequest.Builder> updateResourceShareRequest) throws IdempotentParameterMismatchException, MissingRequiredParameterException, UnknownResourceException, MalformedArnException, InvalidClientTokenException, InvalidParameterException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException
Updates the specified resource share that you own.
This is a convenience which creates an instance of the UpdateResourceShareRequest.Builder avoiding the
need to create one manually via UpdateResourceShareRequest.builder()
updateResourceShareRequest - A Consumer that will call methods on UpdateResourceShareRequest.Builder to create a
request.IdempotentParameterMismatchException - A client token input parameter was reused with an operation, but at least one of the other input
parameters is different from the previous call to the operation.MissingRequiredParameterException - A required input parameter is missing.UnknownResourceException - A specified resource was not found.MalformedArnException - The format of an Amazon Resource Name (ARN) is not valid.InvalidClientTokenException - A client token is not valid.InvalidParameterException - A parameter is not valid.OperationNotPermittedException - The requested operation is not permitted.ServerInternalException - The service could not respond to the request due to an internal problem.ServiceUnavailableException - The service is not available.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2021. All rights reserved.