Interface SecurityIrAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
This guide provides documents the action and response elements for customer use of the service.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchGetMemberAccountDetails
(Consumer<BatchGetMemberAccountDetailsRequest.Builder> batchGetMemberAccountDetailsRequest) Grants permission to view an existing membership.batchGetMemberAccountDetails
(BatchGetMemberAccountDetailsRequest batchGetMemberAccountDetailsRequest) Grants permission to view an existing membership.static SecurityIrAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSecurityIrAsyncClient
.cancelMembership
(Consumer<CancelMembershipRequest.Builder> cancelMembershipRequest) Grants permissions to cancel an existing membership.cancelMembership
(CancelMembershipRequest cancelMembershipRequest) Grants permissions to cancel an existing membership.default CompletableFuture
<CloseCaseResponse> closeCase
(Consumer<CloseCaseRequest.Builder> closeCaseRequest) Grants permission to close an existing case.default CompletableFuture
<CloseCaseResponse> closeCase
(CloseCaseRequest closeCaseRequest) Grants permission to close an existing case.static SecurityIrAsyncClient
create()
Create aSecurityIrAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateCaseResponse> createCase
(Consumer<CreateCaseRequest.Builder> createCaseRequest) Grants permission to create a new case.default CompletableFuture
<CreateCaseResponse> createCase
(CreateCaseRequest createCaseRequest) Grants permission to create a new case.createCaseComment
(Consumer<CreateCaseCommentRequest.Builder> createCaseCommentRequest) Grants permission to add a comment to an existing case.createCaseComment
(CreateCaseCommentRequest createCaseCommentRequest) Grants permission to add a comment to an existing case.createMembership
(Consumer<CreateMembershipRequest.Builder> createMembershipRequest) Grants permissions to create a new membership.createMembership
(CreateMembershipRequest createMembershipRequest) Grants permissions to create a new membership.default CompletableFuture
<GetCaseResponse> getCase
(Consumer<GetCaseRequest.Builder> getCaseRequest) Grant permission to view a designated case.default CompletableFuture
<GetCaseResponse> getCase
(GetCaseRequest getCaseRequest) Grant permission to view a designated case.getCaseAttachmentDownloadUrl
(Consumer<GetCaseAttachmentDownloadUrlRequest.Builder> getCaseAttachmentDownloadUrlRequest) Grants permission to obtain an Amazon S3 presigned URL to download an attachment.getCaseAttachmentDownloadUrl
(GetCaseAttachmentDownloadUrlRequest getCaseAttachmentDownloadUrlRequest) Grants permission to obtain an Amazon S3 presigned URL to download an attachment.getCaseAttachmentUploadUrl
(Consumer<GetCaseAttachmentUploadUrlRequest.Builder> getCaseAttachmentUploadUrlRequest) Grants permission to upload an attachment to a case.getCaseAttachmentUploadUrl
(GetCaseAttachmentUploadUrlRequest getCaseAttachmentUploadUrlRequest) Grants permission to upload an attachment to a case.default CompletableFuture
<GetMembershipResponse> getMembership
(Consumer<GetMembershipRequest.Builder> getMembershipRequest) Grants permission to get details of a designated service membership.default CompletableFuture
<GetMembershipResponse> getMembership
(GetMembershipRequest getMembershipRequest) Grants permission to get details of a designated service membership.default CompletableFuture
<ListCaseEditsResponse> listCaseEdits
(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest) Grants permissions to view the aidt log for edits made to a designated case.default CompletableFuture
<ListCaseEditsResponse> listCaseEdits
(ListCaseEditsRequest listCaseEditsRequest) Grants permissions to view the aidt log for edits made to a designated case.default ListCaseEditsPublisher
listCaseEditsPaginator
(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest) This is a variant oflistCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest)
operation.default ListCaseEditsPublisher
listCaseEditsPaginator
(ListCaseEditsRequest listCaseEditsRequest) This is a variant oflistCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest)
operation.default CompletableFuture
<ListCasesResponse> listCases
(Consumer<ListCasesRequest.Builder> listCasesRequest) Grants permission to list all cases the requester has access to.default CompletableFuture
<ListCasesResponse> listCases
(ListCasesRequest listCasesRequest) Grants permission to list all cases the requester has access to.default ListCasesPublisher
listCasesPaginator
(Consumer<ListCasesRequest.Builder> listCasesRequest) This is a variant oflistCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest)
operation.default ListCasesPublisher
listCasesPaginator
(ListCasesRequest listCasesRequest) This is a variant oflistCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest)
operation.default CompletableFuture
<ListCommentsResponse> listComments
(Consumer<ListCommentsRequest.Builder> listCommentsRequest) Grants permissions to list and view comments for a designated case.default CompletableFuture
<ListCommentsResponse> listComments
(ListCommentsRequest listCommentsRequest) Grants permissions to list and view comments for a designated case.default ListCommentsPublisher
listCommentsPaginator
(Consumer<ListCommentsRequest.Builder> listCommentsRequest) This is a variant oflistComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest)
operation.default ListCommentsPublisher
listCommentsPaginator
(ListCommentsRequest listCommentsRequest) This is a variant oflistComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest)
operation.default CompletableFuture
<ListMembershipsResponse> listMemberships
(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) Grants permission to query the memberships a principal has access to.default CompletableFuture
<ListMembershipsResponse> listMemberships
(ListMembershipsRequest listMembershipsRequest) Grants permission to query the memberships a principal has access to.default ListMembershipsPublisher
listMembershipsPaginator
(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) This is a variant oflistMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest)
operation.default ListMembershipsPublisher
listMembershipsPaginator
(ListMembershipsRequest listMembershipsRequest) This is a variant oflistMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Grants permission to view currently configured tags on a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Grants permission to view currently configured tags on a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Grants permission to add a tag(s) to a designated resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Grants permission to add a tag(s) to a designated resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Grants permission to remove a tag(s) from a designate resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Grants permission to remove a tag(s) from a designate resource.default CompletableFuture
<UpdateCaseResponse> updateCase
(Consumer<UpdateCaseRequest.Builder> updateCaseRequest) Grants permission to update an existing case.default CompletableFuture
<UpdateCaseResponse> updateCase
(UpdateCaseRequest updateCaseRequest) Grants permission to update an existing case.updateCaseComment
(Consumer<UpdateCaseCommentRequest.Builder> updateCaseCommentRequest) Grants permission to update an existing case comment.updateCaseComment
(UpdateCaseCommentRequest updateCaseCommentRequest) Grants permission to update an existing case comment.updateCaseStatus
(Consumer<UpdateCaseStatusRequest.Builder> updateCaseStatusRequest) Grants permission to update the status for a designated cases.updateCaseStatus
(UpdateCaseStatusRequest updateCaseStatusRequest) Grants permission to update the status for a designated cases.updateMembership
(Consumer<UpdateMembershipRequest.Builder> updateMembershipRequest) Grants access to UpdateMembership to change membership configuration.updateMembership
(UpdateMembershipRequest updateMembershipRequest) Grants access to UpdateMembership to change membership configuration.updateResolverType
(Consumer<UpdateResolverTypeRequest.Builder> updateResolverTypeRequest) Grants permission to update the resolver type for a case.updateResolverType
(UpdateResolverTypeRequest updateResolverTypeRequest) Grants permission to update the resolver type for a case.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
-
batchGetMemberAccountDetails
default CompletableFuture<BatchGetMemberAccountDetailsResponse> batchGetMemberAccountDetails(BatchGetMemberAccountDetailsRequest batchGetMemberAccountDetailsRequest) Grants permission to view an existing membership.
- Parameters:
batchGetMemberAccountDetailsRequest
-- Returns:
- A Java Future containing the result of the BatchGetMemberAccountDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetMemberAccountDetails
default CompletableFuture<BatchGetMemberAccountDetailsResponse> batchGetMemberAccountDetails(Consumer<BatchGetMemberAccountDetailsRequest.Builder> batchGetMemberAccountDetailsRequest) Grants permission to view an existing membership.
This is a convenience which creates an instance of the
BatchGetMemberAccountDetailsRequest.Builder
avoiding the need to create one manually viaBatchGetMemberAccountDetailsRequest.builder()
- Parameters:
batchGetMemberAccountDetailsRequest
- AConsumer
that will call methods onBatchGetMemberAccountDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetMemberAccountDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelMembership
default CompletableFuture<CancelMembershipResponse> cancelMembership(CancelMembershipRequest cancelMembershipRequest) Grants permissions to cancel an existing membership.
- Parameters:
cancelMembershipRequest
-- Returns:
- A Java Future containing the result of the CancelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelMembership
default CompletableFuture<CancelMembershipResponse> cancelMembership(Consumer<CancelMembershipRequest.Builder> cancelMembershipRequest) Grants permissions to cancel an existing membership.
This is a convenience which creates an instance of the
CancelMembershipRequest.Builder
avoiding the need to create one manually viaCancelMembershipRequest.builder()
- Parameters:
cancelMembershipRequest
- AConsumer
that will call methods onCancelMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
closeCase
Grants permission to close an existing case.
- Parameters:
closeCaseRequest
-- Returns:
- A Java Future containing the result of the CloseCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
closeCase
default CompletableFuture<CloseCaseResponse> closeCase(Consumer<CloseCaseRequest.Builder> closeCaseRequest) Grants permission to close an existing case.
This is a convenience which creates an instance of the
CloseCaseRequest.Builder
avoiding the need to create one manually viaCloseCaseRequest.builder()
- Parameters:
closeCaseRequest
- AConsumer
that will call methods onCloseCaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CloseCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCase
Grants permission to create a new case.
- Parameters:
createCaseRequest
-- Returns:
- A Java Future containing the result of the CreateCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCase
default CompletableFuture<CreateCaseResponse> createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest) Grants permission to create a new case.
This is a convenience which creates an instance of the
CreateCaseRequest.Builder
avoiding the need to create one manually viaCreateCaseRequest.builder()
- Parameters:
createCaseRequest
- AConsumer
that will call methods onCreateCaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCaseComment
default CompletableFuture<CreateCaseCommentResponse> createCaseComment(CreateCaseCommentRequest createCaseCommentRequest) Grants permission to add a comment to an existing case.
- Parameters:
createCaseCommentRequest
-- Returns:
- A Java Future containing the result of the CreateCaseComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCaseComment
default CompletableFuture<CreateCaseCommentResponse> createCaseComment(Consumer<CreateCaseCommentRequest.Builder> createCaseCommentRequest) Grants permission to add a comment to an existing case.
This is a convenience which creates an instance of the
CreateCaseCommentRequest.Builder
avoiding the need to create one manually viaCreateCaseCommentRequest.builder()
- Parameters:
createCaseCommentRequest
- AConsumer
that will call methods onCreateCaseCommentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCaseComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMembership
default CompletableFuture<CreateMembershipResponse> createMembership(CreateMembershipRequest createMembershipRequest) Grants permissions to create a new membership.
- Parameters:
createMembershipRequest
-- Returns:
- A Java Future containing the result of the CreateMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMembership
default CompletableFuture<CreateMembershipResponse> createMembership(Consumer<CreateMembershipRequest.Builder> createMembershipRequest) Grants permissions to create a new membership.
This is a convenience which creates an instance of the
CreateMembershipRequest.Builder
avoiding the need to create one manually viaCreateMembershipRequest.builder()
- Parameters:
createMembershipRequest
- AConsumer
that will call methods onCreateMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCase
Grant permission to view a designated case.
- Parameters:
getCaseRequest
-- Returns:
- A Java Future containing the result of the GetCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCase
Grant permission to view a designated case.
This is a convenience which creates an instance of the
GetCaseRequest.Builder
avoiding the need to create one manually viaGetCaseRequest.builder()
- Parameters:
getCaseRequest
- AConsumer
that will call methods onGetCaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCaseAttachmentDownloadUrl
default CompletableFuture<GetCaseAttachmentDownloadUrlResponse> getCaseAttachmentDownloadUrl(GetCaseAttachmentDownloadUrlRequest getCaseAttachmentDownloadUrlRequest) Grants permission to obtain an Amazon S3 presigned URL to download an attachment.
- Parameters:
getCaseAttachmentDownloadUrlRequest
-- Returns:
- A Java Future containing the result of the GetCaseAttachmentDownloadUrl operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCaseAttachmentDownloadUrl
default CompletableFuture<GetCaseAttachmentDownloadUrlResponse> getCaseAttachmentDownloadUrl(Consumer<GetCaseAttachmentDownloadUrlRequest.Builder> getCaseAttachmentDownloadUrlRequest) Grants permission to obtain an Amazon S3 presigned URL to download an attachment.
This is a convenience which creates an instance of the
GetCaseAttachmentDownloadUrlRequest.Builder
avoiding the need to create one manually viaGetCaseAttachmentDownloadUrlRequest.builder()
- Parameters:
getCaseAttachmentDownloadUrlRequest
- AConsumer
that will call methods onGetCaseAttachmentDownloadUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCaseAttachmentDownloadUrl operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCaseAttachmentUploadUrl
default CompletableFuture<GetCaseAttachmentUploadUrlResponse> getCaseAttachmentUploadUrl(GetCaseAttachmentUploadUrlRequest getCaseAttachmentUploadUrlRequest) Grants permission to upload an attachment to a case.
- Parameters:
getCaseAttachmentUploadUrlRequest
-- Returns:
- A Java Future containing the result of the GetCaseAttachmentUploadUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCaseAttachmentUploadUrl
default CompletableFuture<GetCaseAttachmentUploadUrlResponse> getCaseAttachmentUploadUrl(Consumer<GetCaseAttachmentUploadUrlRequest.Builder> getCaseAttachmentUploadUrlRequest) Grants permission to upload an attachment to a case.
This is a convenience which creates an instance of the
GetCaseAttachmentUploadUrlRequest.Builder
avoiding the need to create one manually viaGetCaseAttachmentUploadUrlRequest.builder()
- Parameters:
getCaseAttachmentUploadUrlRequest
- AConsumer
that will call methods onGetCaseAttachmentUploadUrlRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCaseAttachmentUploadUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMembership
default CompletableFuture<GetMembershipResponse> getMembership(GetMembershipRequest getMembershipRequest) Grants permission to get details of a designated service membership.
- Parameters:
getMembershipRequest
-- Returns:
- A Java Future containing the result of the GetMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMembership
default CompletableFuture<GetMembershipResponse> getMembership(Consumer<GetMembershipRequest.Builder> getMembershipRequest) Grants permission to get details of a designated service membership.
This is a convenience which creates an instance of the
GetMembershipRequest.Builder
avoiding the need to create one manually viaGetMembershipRequest.builder()
- Parameters:
getMembershipRequest
- AConsumer
that will call methods onGetMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCaseEdits
default CompletableFuture<ListCaseEditsResponse> listCaseEdits(ListCaseEditsRequest listCaseEditsRequest) Grants permissions to view the aidt log for edits made to a designated case.
- Parameters:
listCaseEditsRequest
-- Returns:
- A Java Future containing the result of the ListCaseEdits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCaseEdits
default CompletableFuture<ListCaseEditsResponse> listCaseEdits(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest) Grants permissions to view the aidt log for edits made to a designated case.
This is a convenience which creates an instance of the
ListCaseEditsRequest.Builder
avoiding the need to create one manually viaListCaseEditsRequest.builder()
- Parameters:
listCaseEditsRequest
- AConsumer
that will call methods onListCaseEditsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCaseEdits operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCaseEditsPaginator
This is a variant of
listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListCaseEditsPublisher publisher = client.listCaseEditsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListCaseEditsPublisher publisher = client.listCaseEditsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListCaseEditsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListCaseEditsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest)
operation.- Parameters:
listCaseEditsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCaseEditsPaginator
default ListCaseEditsPublisher listCaseEditsPaginator(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest) This is a variant of
listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListCaseEditsPublisher publisher = client.listCaseEditsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListCaseEditsPublisher publisher = client.listCaseEditsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListCaseEditsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListCaseEditsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest)
operation.
This is a convenience which creates an instance of the
ListCaseEditsRequest.Builder
avoiding the need to create one manually viaListCaseEditsRequest.builder()
- Parameters:
listCaseEditsRequest
- AConsumer
that will call methods onListCaseEditsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCases
Grants permission to list all cases the requester has access to.
- Parameters:
listCasesRequest
-- Returns:
- A Java Future containing the result of the ListCases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCases
default CompletableFuture<ListCasesResponse> listCases(Consumer<ListCasesRequest.Builder> listCasesRequest) Grants permission to list all cases the requester has access to.
This is a convenience which creates an instance of the
ListCasesRequest.Builder
avoiding the need to create one manually viaListCasesRequest.builder()
- Parameters:
listCasesRequest
- AConsumer
that will call methods onListCasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCasesPaginator
This is a variant of
listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListCasesPublisher publisher = client.listCasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListCasesPublisher publisher = client.listCasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListCasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListCasesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest)
operation.- Parameters:
listCasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCasesPaginator
This is a variant of
listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListCasesPublisher publisher = client.listCasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListCasesPublisher publisher = client.listCasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListCasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListCasesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest)
operation.
This is a convenience which creates an instance of the
ListCasesRequest.Builder
avoiding the need to create one manually viaListCasesRequest.builder()
- Parameters:
listCasesRequest
- AConsumer
that will call methods onListCasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listComments
default CompletableFuture<ListCommentsResponse> listComments(ListCommentsRequest listCommentsRequest) Grants permissions to list and view comments for a designated case.
- Parameters:
listCommentsRequest
-- Returns:
- A Java Future containing the result of the ListComments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listComments
default CompletableFuture<ListCommentsResponse> listComments(Consumer<ListCommentsRequest.Builder> listCommentsRequest) Grants permissions to list and view comments for a designated case.
This is a convenience which creates an instance of the
ListCommentsRequest.Builder
avoiding the need to create one manually viaListCommentsRequest.builder()
- Parameters:
listCommentsRequest
- AConsumer
that will call methods onListCommentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListComments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCommentsPaginator
This is a variant of
listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListCommentsPublisher publisher = client.listCommentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListCommentsPublisher publisher = client.listCommentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListCommentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListCommentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest)
operation.- Parameters:
listCommentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCommentsPaginator
default ListCommentsPublisher listCommentsPaginator(Consumer<ListCommentsRequest.Builder> listCommentsRequest) This is a variant of
listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListCommentsPublisher publisher = client.listCommentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListCommentsPublisher publisher = client.listCommentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListCommentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListCommentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest)
operation.
This is a convenience which creates an instance of the
ListCommentsRequest.Builder
avoiding the need to create one manually viaListCommentsRequest.builder()
- Parameters:
listCommentsRequest
- AConsumer
that will call methods onListCommentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMemberships
default CompletableFuture<ListMembershipsResponse> listMemberships(ListMembershipsRequest listMembershipsRequest) Grants permission to query the memberships a principal has access to.
- Parameters:
listMembershipsRequest
-- Returns:
- A Java Future containing the result of the ListMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMemberships
default CompletableFuture<ListMembershipsResponse> listMemberships(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) Grants permission to query the memberships a principal has access to.
This is a convenience which creates an instance of the
ListMembershipsRequest.Builder
avoiding the need to create one manually viaListMembershipsRequest.builder()
- Parameters:
listMembershipsRequest
- AConsumer
that will call methods onListMembershipsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMemberships operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembershipsPaginator
default ListMembershipsPublisher listMembershipsPaginator(ListMembershipsRequest listMembershipsRequest) This is a variant of
listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListMembershipsPublisher publisher = client.listMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListMembershipsPublisher publisher = client.listMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListMembershipsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest)
operation.- Parameters:
listMembershipsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMembershipsPaginator
default ListMembershipsPublisher listMembershipsPaginator(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest) This is a variant of
listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.securityir.paginators.ListMembershipsPublisher publisher = client.listMembershipsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.securityir.paginators.ListMembershipsPublisher publisher = client.listMembershipsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.securityir.model.ListMembershipsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.securityir.model.ListMembershipsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest)
operation.
This is a convenience which creates an instance of the
ListMembershipsRequest.Builder
avoiding the need to create one manually viaListMembershipsRequest.builder()
- Parameters:
listMembershipsRequest
- AConsumer
that will call methods onListMembershipsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Grants permission to view currently configured tags on a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ResourceNotFoundException
- ThrottlingException
- ConflictException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Grants permission to view currently configured tags on a resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ResourceNotFoundException
- ThrottlingException
- ConflictException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Grants permission to add a tag(s) to a designated resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ResourceNotFoundException
- ThrottlingException
- ConflictException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Grants permission to add a tag(s) to a designated resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ResourceNotFoundException
- ThrottlingException
- ConflictException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Grants permission to remove a tag(s) from a designate resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ResourceNotFoundException
- ThrottlingException
- ConflictException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Grants permission to remove a tag(s) from a designate resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ResourceNotFoundException
- ThrottlingException
- ConflictException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCase
Grants permission to update an existing case.
- Parameters:
updateCaseRequest
-- Returns:
- A Java Future containing the result of the UpdateCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCase
default CompletableFuture<UpdateCaseResponse> updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest) Grants permission to update an existing case.
This is a convenience which creates an instance of the
UpdateCaseRequest.Builder
avoiding the need to create one manually viaUpdateCaseRequest.builder()
- Parameters:
updateCaseRequest
- AConsumer
that will call methods onUpdateCaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCaseComment
default CompletableFuture<UpdateCaseCommentResponse> updateCaseComment(UpdateCaseCommentRequest updateCaseCommentRequest) Grants permission to update an existing case comment.
- Parameters:
updateCaseCommentRequest
-- Returns:
- A Java Future containing the result of the UpdateCaseComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCaseComment
default CompletableFuture<UpdateCaseCommentResponse> updateCaseComment(Consumer<UpdateCaseCommentRequest.Builder> updateCaseCommentRequest) Grants permission to update an existing case comment.
This is a convenience which creates an instance of the
UpdateCaseCommentRequest.Builder
avoiding the need to create one manually viaUpdateCaseCommentRequest.builder()
- Parameters:
updateCaseCommentRequest
- AConsumer
that will call methods onUpdateCaseCommentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCaseComment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCaseStatus
default CompletableFuture<UpdateCaseStatusResponse> updateCaseStatus(UpdateCaseStatusRequest updateCaseStatusRequest) Grants permission to update the status for a designated cases. Options include
Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed
.- Parameters:
updateCaseStatusRequest
-- Returns:
- A Java Future containing the result of the UpdateCaseStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateCaseStatus
default CompletableFuture<UpdateCaseStatusResponse> updateCaseStatus(Consumer<UpdateCaseStatusRequest.Builder> updateCaseStatusRequest) Grants permission to update the status for a designated cases. Options include
Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed
.
This is a convenience which creates an instance of the
UpdateCaseStatusRequest.Builder
avoiding the need to create one manually viaUpdateCaseStatusRequest.builder()
- Parameters:
updateCaseStatusRequest
- AConsumer
that will call methods onUpdateCaseStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateCaseStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMembership
default CompletableFuture<UpdateMembershipResponse> updateMembership(UpdateMembershipRequest updateMembershipRequest) Grants access to UpdateMembership to change membership configuration.
- Parameters:
updateMembershipRequest
-- Returns:
- A Java Future containing the result of the UpdateMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMembership
default CompletableFuture<UpdateMembershipResponse> updateMembership(Consumer<UpdateMembershipRequest.Builder> updateMembershipRequest) Grants access to UpdateMembership to change membership configuration.
This is a convenience which creates an instance of the
UpdateMembershipRequest.Builder
avoiding the need to create one manually viaUpdateMembershipRequest.builder()
- Parameters:
updateMembershipRequest
- AConsumer
that will call methods onUpdateMembershipRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMembership operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResolverType
default CompletableFuture<UpdateResolverTypeResponse> updateResolverType(UpdateResolverTypeRequest updateResolverTypeRequest) Grants permission to update the resolver type for a case.
This is a one-way action and cannot be reversed.
Options include self-supported > AWS-supported.
- Parameters:
updateResolverTypeRequest
-- Returns:
- A Java Future containing the result of the UpdateResolverType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateResolverType
default CompletableFuture<UpdateResolverTypeResponse> updateResolverType(Consumer<UpdateResolverTypeRequest.Builder> updateResolverTypeRequest) Grants permission to update the resolver type for a case.
This is a one-way action and cannot be reversed.
Options include self-supported > AWS-supported.
This is a convenience which creates an instance of the
UpdateResolverTypeRequest.Builder
avoiding the need to create one manually viaUpdateResolverTypeRequest.builder()
- Parameters:
updateResolverTypeRequest
- AConsumer
that will call methods onUpdateResolverTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateResolverType operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException
- AccessDeniedException
- ValidationException
- SecurityIncidentResponseNotActiveException
- InternalServerException
- ThrottlingException
- ConflictException
- ResourceNotFoundException
- InvalidTokenException
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- SecurityIrException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSecurityIrAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSecurityIrAsyncClient
.
-