Interface RamClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
This is the Resource Access Manager API Reference. This documentation provides descriptions and syntax for each of the actions and data types in RAM. RAM is a service that helps you securely share your Amazon Web Services resources to other Amazon Web Services accounts. If you use Organizations to manage your accounts, then you can share your resources with your entire organization or to organizational units (OUs). For supported resource types, you can also share resources with individual Identity and Access Management (IAM) roles and users.
To learn more about RAM, see the following resources:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionacceptResourceShareInvitation
(Consumer<AcceptResourceShareInvitationRequest.Builder> acceptResourceShareInvitationRequest) Accepts an invitation to a resource share from another Amazon Web Services account.acceptResourceShareInvitation
(AcceptResourceShareInvitationRequest acceptResourceShareInvitationRequest) Accepts an invitation to a resource share from another Amazon Web Services account.default AssociateResourceShareResponse
associateResourceShare
(Consumer<AssociateResourceShareRequest.Builder> associateResourceShareRequest) Adds the specified list of principals and list of resources to a resource share.default AssociateResourceShareResponse
associateResourceShare
(AssociateResourceShareRequest associateResourceShareRequest) Adds the specified list of principals and list of resources to a resource share.associateResourceSharePermission
(Consumer<AssociateResourceSharePermissionRequest.Builder> associateResourceSharePermissionRequest) Adds or replaces the RAM permission for a resource type included in a resource share.associateResourceSharePermission
(AssociateResourceSharePermissionRequest associateResourceSharePermissionRequest) Adds or replaces the RAM permission for a resource type included in a resource share.static RamClientBuilder
builder()
Create a builder that can be used to configure and create aRamClient
.static RamClient
create()
Create aRamClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreatePermissionResponse
createPermission
(Consumer<CreatePermissionRequest.Builder> createPermissionRequest) Creates a customer managed permission for a specified resource type that you can attach to resource shares.default CreatePermissionResponse
createPermission
(CreatePermissionRequest createPermissionRequest) Creates a customer managed permission for a specified resource type that you can attach to resource shares.default CreatePermissionVersionResponse
createPermissionVersion
(Consumer<CreatePermissionVersionRequest.Builder> createPermissionVersionRequest) Creates a new version of the specified customer managed permission.default CreatePermissionVersionResponse
createPermissionVersion
(CreatePermissionVersionRequest createPermissionVersionRequest) Creates a new version of the specified customer managed permission.default CreateResourceShareResponse
createResourceShare
(Consumer<CreateResourceShareRequest.Builder> createResourceShareRequest) Creates a resource share.default CreateResourceShareResponse
createResourceShare
(CreateResourceShareRequest createResourceShareRequest) Creates a resource share.default DeletePermissionResponse
deletePermission
(Consumer<DeletePermissionRequest.Builder> deletePermissionRequest) Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation.default DeletePermissionResponse
deletePermission
(DeletePermissionRequest deletePermissionRequest) Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation.default DeletePermissionVersionResponse
deletePermissionVersion
(Consumer<DeletePermissionVersionRequest.Builder> deletePermissionVersionRequest) Deletes one version of a customer managed permission.default DeletePermissionVersionResponse
deletePermissionVersion
(DeletePermissionVersionRequest deletePermissionVersionRequest) Deletes one version of a customer managed permission.default DeleteResourceShareResponse
deleteResourceShare
(Consumer<DeleteResourceShareRequest.Builder> deleteResourceShareRequest) Deletes the specified resource share.default DeleteResourceShareResponse
deleteResourceShare
(DeleteResourceShareRequest deleteResourceShareRequest) Deletes the specified resource share.disassociateResourceShare
(Consumer<DisassociateResourceShareRequest.Builder> disassociateResourceShareRequest) Removes the specified principals or resources from participating in the specified resource share.disassociateResourceShare
(DisassociateResourceShareRequest disassociateResourceShareRequest) Removes the specified principals or resources from participating in the specified resource share.disassociateResourceSharePermission
(Consumer<DisassociateResourceSharePermissionRequest.Builder> disassociateResourceSharePermissionRequest) Removes a managed permission from a resource share.disassociateResourceSharePermission
(DisassociateResourceSharePermissionRequest disassociateResourceSharePermissionRequest) Removes a managed permission from a resource share.Enables resource sharing within your organization in Organizations.enableSharingWithAwsOrganization
(Consumer<EnableSharingWithAwsOrganizationRequest.Builder> enableSharingWithAwsOrganizationRequest) Enables resource sharing within your organization in Organizations.enableSharingWithAwsOrganization
(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) Enables resource sharing within your organization in Organizations.default GetPermissionResponse
getPermission
(Consumer<GetPermissionRequest.Builder> getPermissionRequest) Retrieves the contents of a managed permission in JSON format.default GetPermissionResponse
getPermission
(GetPermissionRequest getPermissionRequest) Retrieves the contents of a managed permission in JSON format.default GetResourcePoliciesResponse
getResourcePolicies
(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) Retrieves the resource policies for the specified resources that you own and have shared.default GetResourcePoliciesResponse
getResourcePolicies
(GetResourcePoliciesRequest getResourcePoliciesRequest) Retrieves the resource policies for the specified resources that you own and have shared.default GetResourcePoliciesIterable
getResourcePoliciesPaginator
(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) This is a variant ofgetResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.default GetResourcePoliciesIterable
getResourcePoliciesPaginator
(GetResourcePoliciesRequest getResourcePoliciesRequest) This is a variant ofgetResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.getResourceShareAssociations
(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) Retrieves the lists of resources and principals that associated for resource shares that you own.getResourceShareAssociations
(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) Retrieves the lists of resources and principals that associated for resource shares that you own.getResourceShareAssociationsPaginator
(Consumer<GetResourceShareAssociationsRequest.Builder> getResourceShareAssociationsRequest) This is a variant ofgetResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)
operation.getResourceShareAssociationsPaginator
(GetResourceShareAssociationsRequest getResourceShareAssociationsRequest) This is a variant ofgetResourceShareAssociations(software.amazon.awssdk.services.ram.model.GetResourceShareAssociationsRequest)
operation.Retrieves details about invitations that you have received for resource shares.getResourceShareInvitations
(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) Retrieves details about invitations that you have received for resource shares.getResourceShareInvitations
(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) Retrieves details about invitations that you have received for resource shares.This is a variant ofgetResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)
operation.getResourceShareInvitationsPaginator
(Consumer<GetResourceShareInvitationsRequest.Builder> getResourceShareInvitationsRequest) This is a variant ofgetResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)
operation.getResourceShareInvitationsPaginator
(GetResourceShareInvitationsRequest getResourceShareInvitationsRequest) This is a variant ofgetResourceShareInvitations(software.amazon.awssdk.services.ram.model.GetResourceShareInvitationsRequest)
operation.default GetResourceSharesResponse
getResourceShares
(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) Retrieves details about the resource shares that you own or that are shared with you.default GetResourceSharesResponse
getResourceShares
(GetResourceSharesRequest getResourceSharesRequest) Retrieves details about the resource shares that you own or that are shared with you.default GetResourceSharesIterable
getResourceSharesPaginator
(Consumer<GetResourceSharesRequest.Builder> getResourceSharesRequest) This is a variant ofgetResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)
operation.default GetResourceSharesIterable
getResourceSharesPaginator
(GetResourceSharesRequest getResourceSharesRequest) This is a variant ofgetResourceShares(software.amazon.awssdk.services.ram.model.GetResourceSharesRequest)
operation.listPendingInvitationResources
(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) Lists the resources in a resource share that is shared with you but for which the invitation is stillPENDING
.listPendingInvitationResources
(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) Lists the resources in a resource share that is shared with you but for which the invitation is stillPENDING
.listPendingInvitationResourcesPaginator
(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) This is a variant oflistPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.listPendingInvitationResourcesPaginator
(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) This is a variant oflistPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.listPermissionAssociations
(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) Lists information about the managed permission and its associations to any resource shares that use this managed permission.listPermissionAssociations
(ListPermissionAssociationsRequest listPermissionAssociationsRequest) Lists information about the managed permission and its associations to any resource shares that use this managed permission.listPermissionAssociationsPaginator
(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) This is a variant oflistPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.listPermissionAssociationsPaginator
(ListPermissionAssociationsRequest listPermissionAssociationsRequest) This is a variant oflistPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.default ListPermissionsResponse
listPermissions
(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) Retrieves a list of available RAM permissions that you can use for the supported resource types.default ListPermissionsResponse
listPermissions
(ListPermissionsRequest listPermissionsRequest) Retrieves a list of available RAM permissions that you can use for the supported resource types.default ListPermissionsIterable
listPermissionsPaginator
(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.default ListPermissionsIterable
listPermissionsPaginator
(ListPermissionsRequest listPermissionsRequest) This is a variant oflistPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.default ListPermissionVersionsResponse
listPermissionVersions
(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) Lists the available versions of the specified RAM permission.default ListPermissionVersionsResponse
listPermissionVersions
(ListPermissionVersionsRequest listPermissionVersionsRequest) Lists the available versions of the specified RAM permission.default ListPermissionVersionsIterable
listPermissionVersionsPaginator
(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) This is a variant oflistPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.default ListPermissionVersionsIterable
listPermissionVersionsPaginator
(ListPermissionVersionsRequest listPermissionVersionsRequest) This is a variant oflistPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.default ListPrincipalsResponse
listPrincipals
(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) Lists the principals that you are sharing resources with or that are sharing resources with you.default ListPrincipalsResponse
listPrincipals
(ListPrincipalsRequest listPrincipalsRequest) Lists the principals that you are sharing resources with or that are sharing resources with you.default ListPrincipalsIterable
listPrincipalsPaginator
(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) This is a variant oflistPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.default ListPrincipalsIterable
listPrincipalsPaginator
(ListPrincipalsRequest listPrincipalsRequest) This is a variant oflistPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.listReplacePermissionAssociationsWork
(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.listReplacePermissionAssociationsWork
(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.listReplacePermissionAssociationsWorkPaginator
(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) This is a variant oflistReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.listReplacePermissionAssociationsWorkPaginator
(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) This is a variant oflistReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.default ListResourcesResponse
listResources
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) Lists the resources that you added to a resource share or the resources that are shared with you.default ListResourcesResponse
listResources
(ListResourcesRequest listResourcesRequest) Lists the resources that you added to a resource share or the resources that are shared with you.listResourceSharePermissions
(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest) Lists the RAM permissions that are associated with a resource share.listResourceSharePermissions
(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) Lists the RAM permissions that are associated with a resource share.listResourceSharePermissionsPaginator
(Consumer<ListResourceSharePermissionsRequest.Builder> listResourceSharePermissionsRequest) This is a variant oflistResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)
operation.listResourceSharePermissionsPaginator
(ListResourceSharePermissionsRequest listResourceSharePermissionsRequest) This is a variant oflistResourceSharePermissions(software.amazon.awssdk.services.ram.model.ListResourceSharePermissionsRequest)
operation.default ListResourcesIterable
listResourcesPaginator
(Consumer<ListResourcesRequest.Builder> listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.default ListResourcesIterable
listResourcesPaginator
(ListResourcesRequest listResourcesRequest) This is a variant oflistResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.default ListResourceTypesResponse
listResourceTypes
(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) Lists the resource types that can be shared by RAM.default ListResourceTypesResponse
listResourceTypes
(ListResourceTypesRequest listResourceTypesRequest) Lists the resource types that can be shared by RAM.default ListResourceTypesIterable
listResourceTypesPaginator
(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) This is a variant oflistResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.default ListResourceTypesIterable
listResourceTypesPaginator
(ListResourceTypesRequest listResourceTypesRequest) This is a variant oflistResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.promotePermissionCreatedFromPolicy
(Consumer<PromotePermissionCreatedFromPolicyRequest.Builder> promotePermissionCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.promotePermissionCreatedFromPolicy
(PromotePermissionCreatedFromPolicyRequest promotePermissionCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.promoteResourceShareCreatedFromPolicy
(Consumer<PromoteResourceShareCreatedFromPolicyRequest.Builder> promoteResourceShareCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.promoteResourceShareCreatedFromPolicy
(PromoteResourceShareCreatedFromPolicyRequest promoteResourceShareCreatedFromPolicyRequest) When you attach a resource-based policy to a resource, RAM automatically creates a resource share offeatureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy.rejectResourceShareInvitation
(Consumer<RejectResourceShareInvitationRequest.Builder> rejectResourceShareInvitationRequest) Rejects an invitation to a resource share from another Amazon Web Services account.rejectResourceShareInvitation
(RejectResourceShareInvitationRequest rejectResourceShareInvitationRequest) Rejects an invitation to a resource share from another Amazon Web Services account.replacePermissionAssociations
(Consumer<ReplacePermissionAssociationsRequest.Builder> replacePermissionAssociationsRequest) Updates all resource shares that use a managed permission to a different managed permission.replacePermissionAssociations
(ReplacePermissionAssociationsRequest replacePermissionAssociationsRequest) Updates all resource shares that use a managed permission to a different managed permission.default RamServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
setDefaultPermissionVersion
(Consumer<SetDefaultPermissionVersionRequest.Builder> setDefaultPermissionVersionRequest) Designates the specified version number as the default version for the specified customer managed permission.setDefaultPermissionVersion
(SetDefaultPermissionVersionRequest setDefaultPermissionVersionRequest) Designates the specified version number as the default version for the specified customer managed permission.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tag keys and values to a resource share or managed permission.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tag keys and values to a resource share or managed permission.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tag key and value pairs from the specified resource share or managed permission.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tag key and value pairs from the specified resource share or managed permission.default UpdateResourceShareResponse
updateResourceShare
(Consumer<UpdateResourceShareRequest.Builder> updateResourceShareRequest) Modifies some of the properties of the specified resource share.default UpdateResourceShareResponse
updateResourceShare
(UpdateResourceShareRequest updateResourceShareRequest) Modifies some of the properties of the specified resource share.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createPermission
default CreatePermissionResponse createPermission(CreatePermissionRequest createPermissionRequest) throws InvalidParameterException, InvalidPolicyException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, PermissionAlreadyExistsException, MalformedPolicyTemplateException, InvalidClientTokenException, PermissionLimitExceededException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.
- Parameters:
createPermissionRequest
-- Returns:
- Result of the CreatePermission operation returned by the service.
- See Also:
-
createPermission
default CreatePermissionResponse createPermission(Consumer<CreatePermissionRequest.Builder> createPermissionRequest) throws InvalidParameterException, InvalidPolicyException, OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, PermissionAlreadyExistsException, MalformedPolicyTemplateException, InvalidClientTokenException, PermissionLimitExceededException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Creates a customer managed permission for a specified resource type that you can attach to resource shares. It is created in the Amazon Web Services Region in which you call the operation.
This is a convenience which creates an instance of the
CreatePermissionRequest.Builder
avoiding the need to create one manually viaCreatePermissionRequest.builder()
- Parameters:
createPermissionRequest
- AConsumer
that will call methods onCreatePermissionRequest.Builder
to create a request.- Returns:
- Result of the CreatePermission operation returned by the service.
- See Also:
-
createPermissionVersion
default CreatePermissionVersionResponse createPermissionVersion(CreatePermissionVersionRequest createPermissionVersionRequest) throws InvalidParameterException, InvalidPolicyException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, MalformedPolicyTemplateException, MalformedArnException, InvalidClientTokenException, IdempotentParameterMismatchException, PermissionVersionsLimitExceededException, AwsServiceException, SdkClientException, RamException Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them.
If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.
- Parameters:
createPermissionVersionRequest
-- Returns:
- Result of the CreatePermissionVersion operation returned by the service.
- See Also:
-
createPermissionVersion
default CreatePermissionVersionResponse createPermissionVersion(Consumer<CreatePermissionVersionRequest.Builder> createPermissionVersionRequest) throws InvalidParameterException, InvalidPolicyException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, MalformedPolicyTemplateException, MalformedArnException, InvalidClientTokenException, IdempotentParameterMismatchException, PermissionVersionsLimitExceededException, AwsServiceException, SdkClientException, RamException Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them.
If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.
This is a convenience which creates an instance of the
CreatePermissionVersionRequest.Builder
avoiding the need to create one manually viaCreatePermissionVersionRequest.builder()
- Parameters:
createPermissionVersionRequest
- AConsumer
that will call methods onCreatePermissionVersionRequest.Builder
to create a request.- Returns:
- Result of the CreatePermissionVersion operation returned by the service.
- See Also:
-
deletePermission
default DeletePermissionResponse deletePermission(DeletePermissionRequest deletePermissionRequest) throws MalformedArnException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.
- Parameters:
deletePermissionRequest
-- Returns:
- Result of the DeletePermission operation returned by the service.
- See Also:
-
deletePermission
default DeletePermissionResponse deletePermission(Consumer<DeletePermissionRequest.Builder> deletePermissionRequest) throws MalformedArnException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Deletes the specified customer managed permission in the Amazon Web Services Region in which you call this operation. You can delete a customer managed permission only if it isn't attached to any resource share. The operation deletes all versions associated with the customer managed permission.
This is a convenience which creates an instance of the
DeletePermissionRequest.Builder
avoiding the need to create one manually viaDeletePermissionRequest.builder()
- Parameters:
deletePermissionRequest
- AConsumer
that will call methods onDeletePermissionRequest.Builder
to create a request.- Returns:
- Result of the DeletePermission operation returned by the service.
- See Also:
-
deletePermissionVersion
default DeletePermissionVersionResponse deletePermissionVersion(DeletePermissionVersionRequest deletePermissionVersionRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.
If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.
- Parameters:
deletePermissionVersionRequest
-- Returns:
- Result of the DeletePermissionVersion operation returned by the service.
- See Also:
-
deletePermissionVersion
default DeletePermissionVersionResponse deletePermissionVersion(Consumer<DeletePermissionVersionRequest.Builder> deletePermissionVersionRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Deletes one version of a customer managed permission. The version you specify must not be attached to any resource share and must not be the default version for the permission.
If a customer managed permission has the maximum of 5 versions, then you must delete at least one version before you can create another.
This is a convenience which creates an instance of the
DeletePermissionVersionRequest.Builder
avoiding the need to create one manually viaDeletePermissionVersionRequest.builder()
- Parameters:
deletePermissionVersionRequest
- AConsumer
that will call methods onDeletePermissionVersionRequest.Builder
to create a request.- Returns:
- Result of the DeletePermissionVersion operation returned by the service.
- See Also:
-
enableSharingWithAwsOrganization
default EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization(EnableSharingWithAwsOrganizationRequest enableSharingWithAwsOrganizationRequest) throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called
AWSServiceRoleForResourceAccessManager
that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.You must call this operation from an IAM role or user in the organization's management account.
- Parameters:
enableSharingWithAwsOrganizationRequest
-- Returns:
- Result of the EnableSharingWithAwsOrganization operation returned by the service.
- See Also:
-
enableSharingWithAwsOrganization
default EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization(Consumer<EnableSharingWithAwsOrganizationRequest.Builder> enableSharingWithAwsOrganizationRequest) throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Enables resource sharing within your organization in Organizations. This operation creates a service-linked role called
AWSServiceRoleForResourceAccessManager
that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.You must call this operation from an IAM role or user in the organization's management account.
This is a convenience which creates an instance of the
EnableSharingWithAwsOrganizationRequest.Builder
avoiding the need to create one manually viaEnableSharingWithAwsOrganizationRequest.builder()
- Parameters:
enableSharingWithAwsOrganizationRequest
- AConsumer
that will call methods onEnableSharingWithAwsOrganizationRequest.Builder
to create a request.- Returns:
- Result of the EnableSharingWithAwsOrganization operation returned by the service.
- See Also:
-
enableSharingWithAwsOrganization
default EnableSharingWithAwsOrganizationResponse enableSharingWithAwsOrganization() throws OperationNotPermittedException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamExceptionEnables resource sharing within your organization in Organizations. This operation creates a service-linked role called
AWSServiceRoleForResourceAccessManager
that has the IAM managed policy named AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to retrieve information about the organization and its structure. This lets you share resources with all of the accounts in the calling account's organization by specifying the organization ID, or all of the accounts in an organizational unit (OU) by specifying the OU ID. Until you enable sharing within the organization, you can specify only individual Amazon Web Services accounts, or for supported resource types, IAM roles and users.You must call this operation from an IAM role or user in the organization's management account.
- Returns:
- Result of the EnableSharingWithAwsOrganization operation returned by the service.
- See Also:
-
getPermission
default GetPermissionResponse getPermission(GetPermissionRequest getPermissionRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException Retrieves the contents of a managed permission in JSON format.
- Parameters:
getPermissionRequest
-- Returns:
- Result of the GetPermission operation returned by the service.
- See Also:
-
getPermission
default GetPermissionResponse getPermission(Consumer<GetPermissionRequest.Builder> getPermissionRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException Retrieves the contents of a managed permission in JSON format.
This is a convenience which creates an instance of the
GetPermissionRequest.Builder
avoiding the need to create one manually viaGetPermissionRequest.builder()
- Parameters:
getPermissionRequest
- AConsumer
that will call methods onGetPermissionRequest.Builder
to create a request.- Returns:
- Result of the GetPermission operation returned by the service.
- See Also:
-
getResourcePolicies
default GetResourcePoliciesResponse getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Retrieves the resource policies for the specified resources that you own and have shared.
- Parameters:
getResourcePoliciesRequest
-- Returns:
- Result of the GetResourcePolicies operation returned by the service.
- See Also:
-
getResourcePolicies
default GetResourcePoliciesResponse getResourcePolicies(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Retrieves the resource policies for the specified resources that you own and have shared.
This is a convenience which creates an instance of the
GetResourcePoliciesRequest.Builder
avoiding the need to create one manually viaGetResourcePoliciesRequest.builder()
- Parameters:
getResourcePoliciesRequest
- AConsumer
that will call methods onGetResourcePoliciesRequest.Builder
to create a request.- Returns:
- Result of the GetResourcePolicies operation returned by the service.
- See Also:
-
getResourcePoliciesPaginator
default GetResourcePoliciesIterable getResourcePoliciesPaginator(GetResourcePoliciesRequest getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client .getResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.- Parameters:
getResourcePoliciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getResourcePoliciesPaginator
default GetResourcePoliciesIterable getResourcePoliciesPaginator(Consumer<GetResourcePoliciesRequest.Builder> getResourcePoliciesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ResourceArnNotFoundException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client .getResourcePoliciesPaginator(request); for (software.amazon.awssdk.services.ram.model.GetResourcePoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.GetResourcePoliciesIterable responses = client.getResourcePoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourcePolicies(software.amazon.awssdk.services.ram.model.GetResourcePoliciesRequest)
operation.
This is a convenience which creates an instance of the
GetResourcePoliciesRequest.Builder
avoiding the need to create one manually viaGetResourcePoliciesRequest.builder()
- Parameters:
getResourcePoliciesRequest
- AConsumer
that will call methods onGetResourcePoliciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPendingInvitationResources
default ListPendingInvitationResourcesResponse listPendingInvitationResources(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException Lists the resources in a resource share that is shared with you but for which the invitation is still
PENDING
. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.- Parameters:
listPendingInvitationResourcesRequest
-- Returns:
- Result of the ListPendingInvitationResources operation returned by the service.
- See Also:
-
listPendingInvitationResources
default ListPendingInvitationResourcesResponse listPendingInvitationResources(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException Lists the resources in a resource share that is shared with you but for which the invitation is still
PENDING
. That means that you haven't accepted or rejected the invitation and the invitation hasn't expired.
This is a convenience which creates an instance of the
ListPendingInvitationResourcesRequest.Builder
avoiding the need to create one manually viaListPendingInvitationResourcesRequest.builder()
- Parameters:
listPendingInvitationResourcesRequest
- AConsumer
that will call methods onListPendingInvitationResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListPendingInvitationResources operation returned by the service.
- See Also:
-
listPendingInvitationResourcesPaginator
default ListPendingInvitationResourcesIterable listPendingInvitationResourcesPaginator(ListPendingInvitationResourcesRequest listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException This is a variant of
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client .listPendingInvitationResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.- Parameters:
listPendingInvitationResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPendingInvitationResourcesPaginator
default ListPendingInvitationResourcesIterable listPendingInvitationResourcesPaginator(Consumer<ListPendingInvitationResourcesRequest.Builder> listPendingInvitationResourcesRequest) throws MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, ResourceShareInvitationArnNotFoundException, MissingRequiredParameterException, ResourceShareInvitationAlreadyRejectedException, ResourceShareInvitationExpiredException, AwsServiceException, SdkClientException, RamException This is a variant of
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client .listPendingInvitationResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPendingInvitationResourcesIterable responses = client.listPendingInvitationResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPendingInvitationResources(software.amazon.awssdk.services.ram.model.ListPendingInvitationResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListPendingInvitationResourcesRequest.Builder
avoiding the need to create one manually viaListPendingInvitationResourcesRequest.builder()
- Parameters:
listPendingInvitationResourcesRequest
- AConsumer
that will call methods onListPendingInvitationResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionAssociations
default ListPermissionAssociationsResponse listPermissionAssociations(ListPermissionAssociationsRequest listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission.
- Parameters:
listPermissionAssociationsRequest
-- Returns:
- Result of the ListPermissionAssociations operation returned by the service.
- See Also:
-
listPermissionAssociations
default ListPermissionAssociationsResponse listPermissionAssociations(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists information about the managed permission and its associations to any resource shares that use this managed permission. This lets you see which resource shares use which versions of the specified managed permission.
This is a convenience which creates an instance of the
ListPermissionAssociationsRequest.Builder
avoiding the need to create one manually viaListPermissionAssociationsRequest.builder()
- Parameters:
listPermissionAssociationsRequest
- AConsumer
that will call methods onListPermissionAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListPermissionAssociations operation returned by the service.
- See Also:
-
listPermissionAssociationsPaginator
default ListPermissionAssociationsIterable listPermissionAssociationsPaginator(ListPermissionAssociationsRequest listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client .listPermissionAssociationsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.- Parameters:
listPermissionAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionAssociationsPaginator
default ListPermissionAssociationsIterable listPermissionAssociationsPaginator(Consumer<ListPermissionAssociationsRequest.Builder> listPermissionAssociationsRequest) throws InvalidParameterException, MalformedArnException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client .listPermissionAssociationsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionAssociationsIterable responses = client.listPermissionAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionAssociations(software.amazon.awssdk.services.ram.model.ListPermissionAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListPermissionAssociationsRequest.Builder
avoiding the need to create one manually viaListPermissionAssociationsRequest.builder()
- Parameters:
listPermissionAssociationsRequest
- AConsumer
that will call methods onListPermissionAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionVersions
default ListPermissionVersionsResponse listPermissionVersions(ListPermissionVersionsRequest listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException Lists the available versions of the specified RAM permission.
- Parameters:
listPermissionVersionsRequest
-- Returns:
- Result of the ListPermissionVersions operation returned by the service.
- See Also:
-
listPermissionVersions
default ListPermissionVersionsResponse listPermissionVersions(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException Lists the available versions of the specified RAM permission.
This is a convenience which creates an instance of the
ListPermissionVersionsRequest.Builder
avoiding the need to create one manually viaListPermissionVersionsRequest.builder()
- Parameters:
listPermissionVersionsRequest
- AConsumer
that will call methods onListPermissionVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListPermissionVersions operation returned by the service.
- See Also:
-
listPermissionVersionsPaginator
default ListPermissionVersionsIterable listPermissionVersionsPaginator(ListPermissionVersionsRequest listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException This is a variant of
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client .listPermissionVersionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.- Parameters:
listPermissionVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionVersionsPaginator
default ListPermissionVersionsIterable listPermissionVersionsPaginator(Consumer<ListPermissionVersionsRequest.Builder> listPermissionVersionsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, InvalidParameterException, AwsServiceException, SdkClientException, RamException This is a variant of
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client .listPermissionVersionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionVersionsIterable responses = client.listPermissionVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionVersions(software.amazon.awssdk.services.ram.model.ListPermissionVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListPermissionVersionsRequest.Builder
avoiding the need to create one manually viaListPermissionVersionsRequest.builder()
- Parameters:
listPermissionVersionsRequest
- AConsumer
that will call methods onListPermissionVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissions
default ListPermissionsResponse listPermissions(ListPermissionsRequest listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException Retrieves a list of available RAM permissions that you can use for the supported resource types.
- Parameters:
listPermissionsRequest
-- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
listPermissions
default ListPermissionsResponse listPermissions(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException Retrieves a list of available RAM permissions that you can use for the supported resource types.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builder
avoiding the need to create one manually viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- Result of the ListPermissions operation returned by the service.
- See Also:
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(ListPermissionsRequest listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException This is a variant of
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.- Parameters:
listPermissionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionsPaginator
default ListPermissionsIterable listPermissionsPaginator(Consumer<ListPermissionsRequest.Builder> listPermissionsRequest) throws InvalidParameterException, InvalidNextTokenException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, AwsServiceException, SdkClientException, RamException This is a variant of
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPermissionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPermissionsIterable responses = client.listPermissionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissions(software.amazon.awssdk.services.ram.model.ListPermissionsRequest)
operation.
This is a convenience which creates an instance of the
ListPermissionsRequest.Builder
avoiding the need to create one manually viaListPermissionsRequest.builder()
- Parameters:
listPermissionsRequest
- AConsumer
that will call methods onListPermissionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPrincipals
default ListPrincipalsResponse listPrincipals(ListPrincipalsRequest listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists the principals that you are sharing resources with or that are sharing resources with you.
- Parameters:
listPrincipalsRequest
-- Returns:
- Result of the ListPrincipals operation returned by the service.
- See Also:
-
listPrincipals
default ListPrincipalsResponse listPrincipals(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists the principals that you are sharing resources with or that are sharing resources with you.
This is a convenience which creates an instance of the
ListPrincipalsRequest.Builder
avoiding the need to create one manually viaListPrincipalsRequest.builder()
- Parameters:
listPrincipalsRequest
- AConsumer
that will call methods onListPrincipalsRequest.Builder
to create a request.- Returns:
- Result of the ListPrincipals operation returned by the service.
- See Also:
-
listPrincipalsPaginator
default ListPrincipalsIterable listPrincipalsPaginator(ListPrincipalsRequest listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPrincipalsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.- Parameters:
listPrincipalsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPrincipalsPaginator
default ListPrincipalsIterable listPrincipalsPaginator(Consumer<ListPrincipalsRequest.Builder> listPrincipalsRequest) throws MalformedArnException, UnknownResourceException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); for (software.amazon.awssdk.services.ram.model.ListPrincipalsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListPrincipalsIterable responses = client.listPrincipalsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrincipals(software.amazon.awssdk.services.ram.model.ListPrincipalsRequest)
operation.
This is a convenience which creates an instance of the
ListPrincipalsRequest.Builder
avoiding the need to create one manually viaListPrincipalsRequest.builder()
- Parameters:
listPrincipalsRequest
- AConsumer
that will call methods onListPrincipalsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReplacePermissionAssociationsWork
default ListReplacePermissionAssociationsWorkResponse listReplacePermissionAssociationsWork(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
- Parameters:
listReplacePermissionAssociationsWorkRequest
-- Returns:
- Result of the ListReplacePermissionAssociationsWork operation returned by the service.
- See Also:
-
listReplacePermissionAssociationsWork
default ListReplacePermissionAssociationsWorkResponse listReplacePermissionAssociationsWork(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException Retrieves the current status of the asynchronous tasks performed by RAM when you perform the ReplacePermissionAssociationsWork operation.
This is a convenience which creates an instance of the
ListReplacePermissionAssociationsWorkRequest.Builder
avoiding the need to create one manually viaListReplacePermissionAssociationsWorkRequest.builder()
- Parameters:
listReplacePermissionAssociationsWorkRequest
- AConsumer
that will call methods onListReplacePermissionAssociationsWorkRequest.Builder
to create a request.- Returns:
- Result of the ListReplacePermissionAssociationsWork operation returned by the service.
- See Also:
-
listReplacePermissionAssociationsWorkPaginator
default ListReplacePermissionAssociationsWorkIterable listReplacePermissionAssociationsWorkPaginator(ListReplacePermissionAssociationsWorkRequest listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException This is a variant of
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client .listReplacePermissionAssociationsWorkPaginator(request); for (software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.- Parameters:
listReplacePermissionAssociationsWorkRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listReplacePermissionAssociationsWorkPaginator
default ListReplacePermissionAssociationsWorkIterable listReplacePermissionAssociationsWorkPaginator(Consumer<ListReplacePermissionAssociationsWorkRequest.Builder> listReplacePermissionAssociationsWorkRequest) throws ServerInternalException, ServiceUnavailableException, InvalidNextTokenException, InvalidParameterException, AwsServiceException, SdkClientException, RamException This is a variant of
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client .listReplacePermissionAssociationsWorkPaginator(request); for (software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListReplacePermissionAssociationsWorkIterable responses = client.listReplacePermissionAssociationsWorkPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listReplacePermissionAssociationsWork(software.amazon.awssdk.services.ram.model.ListReplacePermissionAssociationsWorkRequest)
operation.
This is a convenience which creates an instance of the
ListReplacePermissionAssociationsWorkRequest.Builder
avoiding the need to create one manually viaListReplacePermissionAssociationsWorkRequest.builder()
- Parameters:
listReplacePermissionAssociationsWorkRequest
- AConsumer
that will call methods onListReplacePermissionAssociationsWorkRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceTypes
default ListResourceTypesResponse listResourceTypes(ListResourceTypesRequest listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists the resource types that can be shared by RAM.
- Parameters:
listResourceTypesRequest
-- Returns:
- Result of the ListResourceTypes operation returned by the service.
- See Also:
-
listResourceTypes
default ListResourceTypesResponse listResourceTypes(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists the resource types that can be shared by RAM.
This is a convenience which creates an instance of the
ListResourceTypesRequest.Builder
avoiding the need to create one manually viaListResourceTypesRequest.builder()
- Parameters:
listResourceTypesRequest
- AConsumer
that will call methods onListResourceTypesRequest.Builder
to create a request.- Returns:
- Result of the ListResourceTypes operation returned by the service.
- See Also:
-
listResourceTypesPaginator
default ListResourceTypesIterable listResourceTypesPaginator(ListResourceTypesRequest listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client .listResourceTypesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourceTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.- Parameters:
listResourceTypesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourceTypesPaginator
default ListResourceTypesIterable listResourceTypesPaginator(Consumer<ListResourceTypesRequest.Builder> listResourceTypesRequest) throws InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client .listResourceTypesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourceTypesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourceTypesIterable responses = client.listResourceTypesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceTypes(software.amazon.awssdk.services.ram.model.ListResourceTypesRequest)
operation.
This is a convenience which creates an instance of the
ListResourceTypesRequest.Builder
avoiding the need to create one manually viaListResourceTypesRequest.builder()
- Parameters:
listResourceTypesRequest
- AConsumer
that will call methods onListResourceTypesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResources
default ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists the resources that you added to a resource share or the resources that are shared with you.
- Parameters:
listResourcesRequest
-- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResources
default ListResourcesResponse listResources(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Lists the resources that you added to a resource share or the resources that are shared with you.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- Result of the ListResources operation returned by the service.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(ListResourcesRequest listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.- Parameters:
listResourcesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listResourcesPaginator
default ListResourcesIterable listResourcesPaginator(Consumer<ListResourcesRequest.Builder> listResourcesRequest) throws InvalidResourceTypeException, UnknownResourceException, MalformedArnException, InvalidNextTokenException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException This is a variant of
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); for (software.amazon.awssdk.services.ram.model.ListResourcesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ram.paginators.ListResourcesIterable responses = client.listResourcesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResources(software.amazon.awssdk.services.ram.model.ListResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListResourcesRequest.Builder
avoiding the need to create one manually viaListResourcesRequest.builder()
- Parameters:
listResourcesRequest
- AConsumer
that will call methods onListResourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
promotePermissionCreatedFromPolicy
default PromotePermissionCreatedFromPolicyResponse promotePermissionCreatedFromPolicy(PromotePermissionCreatedFromPolicyRequest promotePermissionCreatedFromPolicyRequest) throws MalformedArnException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares.
Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.
-
The original
CREATED_FROM_POLICY
policy isn't deleted, and resource shares using that original policy aren't automatically updated. -
You can't modify a
CREATED_FROM_POLICY
resource share so you can't associate the new customer managed permission by usingReplacePermsissionAssociations
. However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable customer managed permission to the newly promotedSTANDARD
resource share. -
After you promote a resource share, if the original
CREATED_FROM_POLICY
managed permission has no other associations to A resource share, then RAM automatically deletes it.
- Parameters:
promotePermissionCreatedFromPolicyRequest
-- Returns:
- Result of the PromotePermissionCreatedFromPolicy operation returned by the service.
- See Also:
-
-
promotePermissionCreatedFromPolicy
default PromotePermissionCreatedFromPolicyResponse promotePermissionCreatedFromPolicy(Consumer<PromotePermissionCreatedFromPolicyRequest.Builder> promotePermissionCreatedFromPolicyRequest) throws MalformedArnException, OperationNotPermittedException, InvalidParameterException, MissingRequiredParameterException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, AwsServiceException, SdkClientException, RamException When you attach a resource-based policy to a resource, RAM automatically creates a resource share of
featureSet
=CREATED_FROM_POLICY
with a managed permission that has the same IAM permissions as the original resource-based policy. However, this type of managed permission is visible to only the resource share owner, and the associated resource share can't be modified by using RAM.This operation creates a separate, fully manageable customer managed permission that has the same IAM permissions as the original resource-based policy. You can associate this customer managed permission to any resource shares.
Before you use PromoteResourceShareCreatedFromPolicy, you should first run this operation to ensure that you have an appropriate customer managed permission that can be associated with the promoted resource share.
-
The original
CREATED_FROM_POLICY
policy isn't deleted, and resource shares using that original policy aren't automatically updated. -
You can't modify a
CREATED_FROM_POLICY
resource share so you can't associate the new customer managed permission by usingReplacePermsissionAssociations
. However, if you use PromoteResourceShareCreatedFromPolicy, that operation automatically associates the fully manageable customer managed permission to the newly promotedSTANDARD
resource share. -
After you promote a resource share, if the original
CREATED_FROM_POLICY
managed permission has no other associations to A resource share, then RAM automatically deletes it.
This is a convenience which creates an instance of the
PromotePermissionCreatedFromPolicyRequest.Builder
avoiding the need to create one manually viaPromotePermissionCreatedFromPolicyRequest.builder()
- Parameters:
promotePermissionCreatedFromPolicyRequest
- AConsumer
that will call methods onPromotePermissionCreatedFromPolicyRequest.Builder
to create a request.- Returns:
- Result of the PromotePermissionCreatedFromPolicy operation returned by the service.
- See Also:
-
-
replacePermissionAssociations
default ReplacePermissionAssociationsResponse replacePermissionAssociations(ReplacePermissionAssociationsRequest replacePermissionAssociationsRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.
You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the
fromPermissionArn
andtoPermissionArn
parameters.You can use the optional
fromPermissionVersion
parameter to update only those resources that use a specified version of the managed permission to the new managed permission.To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.
- Parameters:
replacePermissionAssociationsRequest
-- Returns:
- Result of the ReplacePermissionAssociations operation returned by the service.
- See Also:
-
replacePermissionAssociations
default ReplacePermissionAssociationsResponse replacePermissionAssociations(Consumer<ReplacePermissionAssociationsRequest.Builder> replacePermissionAssociationsRequest) throws MalformedArnException, InvalidParameterException, ServerInternalException, ServiceUnavailableException, OperationNotPermittedException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Updates all resource shares that use a managed permission to a different managed permission. This operation always applies the default version of the target managed permission. You can optionally specify that the update applies to only resource shares that currently use a specified version. This enables you to update to the latest version, without changing the which managed permission is used.
You can use this operation to update all of your resource shares to use the current default version of the permission by specifying the same value for the
fromPermissionArn
andtoPermissionArn
parameters.You can use the optional
fromPermissionVersion
parameter to update only those resources that use a specified version of the managed permission to the new managed permission.To successfully perform this operation, you must have permission to update the resource-based policy on all affected resource types.
This is a convenience which creates an instance of the
ReplacePermissionAssociationsRequest.Builder
avoiding the need to create one manually viaReplacePermissionAssociationsRequest.builder()
- Parameters:
replacePermissionAssociationsRequest
- AConsumer
that will call methods onReplacePermissionAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ReplacePermissionAssociations operation returned by the service.
- See Also:
-
setDefaultPermissionVersion
default SetDefaultPermissionVersionResponse setDefaultPermissionVersion(SetDefaultPermissionVersionRequest setDefaultPermissionVersionRequest) throws InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.
- Parameters:
setDefaultPermissionVersionRequest
-- Returns:
- Result of the SetDefaultPermissionVersion operation returned by the service.
- See Also:
-
setDefaultPermissionVersion
default SetDefaultPermissionVersionResponse setDefaultPermissionVersion(Consumer<SetDefaultPermissionVersionRequest.Builder> setDefaultPermissionVersionRequest) throws InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, UnknownResourceException, InvalidClientTokenException, IdempotentParameterMismatchException, AwsServiceException, SdkClientException, RamException Designates the specified version number as the default version for the specified customer managed permission. New resource shares automatically use this new default permission. Existing resource shares continue to use their original permission version, but you can use ReplacePermissionAssociations to update them.
This is a convenience which creates an instance of the
SetDefaultPermissionVersionRequest.Builder
avoiding the need to create one manually viaSetDefaultPermissionVersionRequest.builder()
- Parameters:
setDefaultPermissionVersionRequest
- AConsumer
that will call methods onSetDefaultPermissionVersionRequest.Builder
to create a request.- Returns:
- Result of the SetDefaultPermissionVersion operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, TagLimitExceededException, ResourceArnNotFoundException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share.
The tags on a managed permission are the same for all versions of the managed permission.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, MalformedArnException, UnknownResourceException, TagLimitExceededException, ResourceArnNotFoundException, TagPolicyViolationException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Adds the specified tag keys and values to a resource share or managed permission. If you choose a resource share, the tags are attached to only the resource share, not to the resources that are in the resource share.
The tags on a managed permission are the same for all versions of the managed permission.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws UnknownResourceException, InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Removes the specified tag key and value pairs from the specified resource share or managed permission.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws UnknownResourceException, InvalidParameterException, MalformedArnException, ServerInternalException, ServiceUnavailableException, AwsServiceException, SdkClientException, RamException Removes the specified tag key and value pairs from the specified resource share or managed permission.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
create
Create aRamClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aRamClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration