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 documents the action and response elements for 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) Provides information on whether the supplied account IDs are associated with a membership.batchGetMemberAccountDetails
(BatchGetMemberAccountDetailsRequest batchGetMemberAccountDetailsRequest) Provides information on whether the supplied account IDs are associated with a membership.static SecurityIrAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSecurityIrAsyncClient
.cancelMembership
(Consumer<CancelMembershipRequest.Builder> cancelMembershipRequest) Cancels an existing membership.cancelMembership
(CancelMembershipRequest cancelMembershipRequest) Cancels an existing membership.default CompletableFuture
<CloseCaseResponse> closeCase
(Consumer<CloseCaseRequest.Builder> closeCaseRequest) Closes an existing case.default CompletableFuture
<CloseCaseResponse> closeCase
(CloseCaseRequest closeCaseRequest) Closes 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) Creates a new case.default CompletableFuture
<CreateCaseResponse> createCase
(CreateCaseRequest createCaseRequest) Creates a new case.createCaseComment
(Consumer<CreateCaseCommentRequest.Builder> createCaseCommentRequest) Adds a comment to an existing case.createCaseComment
(CreateCaseCommentRequest createCaseCommentRequest) Adds a comment to an existing case.createMembership
(Consumer<CreateMembershipRequest.Builder> createMembershipRequest) Creates a new membership.createMembership
(CreateMembershipRequest createMembershipRequest) Creates a new membership.default CompletableFuture
<GetCaseResponse> getCase
(Consumer<GetCaseRequest.Builder> getCaseRequest) Returns the attributes of a case.default CompletableFuture
<GetCaseResponse> getCase
(GetCaseRequest getCaseRequest) Returns the attributes of a case.getCaseAttachmentDownloadUrl
(Consumer<GetCaseAttachmentDownloadUrlRequest.Builder> getCaseAttachmentDownloadUrlRequest) Returns a Pre-Signed URL for uploading attachments into a case.getCaseAttachmentDownloadUrl
(GetCaseAttachmentDownloadUrlRequest getCaseAttachmentDownloadUrlRequest) Returns a Pre-Signed URL for uploading attachments into a case.getCaseAttachmentUploadUrl
(Consumer<GetCaseAttachmentUploadUrlRequest.Builder> getCaseAttachmentUploadUrlRequest) Uploads an attachment to a case.getCaseAttachmentUploadUrl
(GetCaseAttachmentUploadUrlRequest getCaseAttachmentUploadUrlRequest) Uploads an attachment to a case.default CompletableFuture
<GetMembershipResponse> getMembership
(Consumer<GetMembershipRequest.Builder> getMembershipRequest) Returns the attributes of a membership.default CompletableFuture
<GetMembershipResponse> getMembership
(GetMembershipRequest getMembershipRequest) Returns the attributes of a membership.default CompletableFuture
<ListCaseEditsResponse> listCaseEdits
(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest) Views the case history for edits made to a designated case.default CompletableFuture
<ListCaseEditsResponse> listCaseEdits
(ListCaseEditsRequest listCaseEditsRequest) Views the case history 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) Lists all cases the requester has access to.default CompletableFuture
<ListCasesResponse> listCases
(ListCasesRequest listCasesRequest) Lists 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) Returns comments for a designated case.default CompletableFuture
<ListCommentsResponse> listComments
(ListCommentsRequest listCommentsRequest) Returns 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) Returns the memberships that the calling principal can access.default CompletableFuture
<ListMembershipsResponse> listMemberships
(ListMembershipsRequest listMembershipsRequest) Returns the memberships that the calling principal can access.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) Returns currently configured tags on a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns 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) Adds a tag(s) to a designated resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds a tag(s) to a designated resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes a tag(s) from a designate resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes a tag(s) from a designate resource.default CompletableFuture
<UpdateCaseResponse> updateCase
(Consumer<UpdateCaseRequest.Builder> updateCaseRequest) Updates an existing case.default CompletableFuture
<UpdateCaseResponse> updateCase
(UpdateCaseRequest updateCaseRequest) Updates an existing case.updateCaseComment
(Consumer<UpdateCaseCommentRequest.Builder> updateCaseCommentRequest) Updates an existing case comment.updateCaseComment
(UpdateCaseCommentRequest updateCaseCommentRequest) Updates an existing case comment.updateCaseStatus
(Consumer<UpdateCaseStatusRequest.Builder> updateCaseStatusRequest) Updates the state transitions for a designated cases.updateCaseStatus
(UpdateCaseStatusRequest updateCaseStatusRequest) Updates the state transitions for a designated cases.updateMembership
(Consumer<UpdateMembershipRequest.Builder> updateMembershipRequest) Updates membership configuration.updateMembership
(UpdateMembershipRequest updateMembershipRequest) Updates membership configuration.updateResolverType
(Consumer<UpdateResolverTypeRequest.Builder> updateResolverTypeRequest) Updates the resolver type for a case.updateResolverType
(UpdateResolverTypeRequest updateResolverTypeRequest) Updates 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) Provides information on whether the supplied account IDs are associated with a membership.
AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be
123123123
which is nine digits, and with zero-prepend would be000123123123
. Not zero-prepending to 12 digits could result in errors.- 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) Provides information on whether the supplied account IDs are associated with a membership.
AWS account ID's may appear less than 12 characters and need to be zero-prepended. An example would be
123123123
which is nine digits, and with zero-prepend would be000123123123
. Not zero-prepending to 12 digits could result in errors.
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) Cancels 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) Cancels 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
Closes 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) Closes 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
Creates 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) Creates 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) Adds 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) Adds 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) Creates 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) Creates 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
Returns the attributes of a 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
Returns the attributes of a 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) Returns a Pre-Signed URL for uploading attachments into a case.
- 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) Returns a Pre-Signed URL for uploading attachments into a case.
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) Uploads 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) Uploads 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) Returns the attributes of a 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) Returns the attributes of a 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) Views the case history 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) Views the case history 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
Lists 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) Lists 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) Returns 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) Returns 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) Returns the memberships that the calling principal can access.
- 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) Returns the memberships that the calling principal can access.
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) Returns 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) Returns 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
Adds 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) Adds 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) Removes 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) Removes 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
Updates 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) Updates 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) Updates 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) Updates 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) Updates the state transitions for a designated cases.
Self-managed: the following states are available for self-managed cases.
-
Submitted → Detection and Analysis
-
Detection and Analysis → Containment, Eradication, and Recovery
-
Detection and Analysis → Post-incident Activities
-
Containment, Eradication, and Recovery → Detection and Analysis
-
Containment, Eradication, and Recovery → Post-incident Activities
-
Post-incident Activities → Containment, Eradication, and Recovery
-
Post-incident Activities → Detection and Analysis
-
Any → Closed
AWS supported: You must use the
CloseCase
API to close.- 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) Updates the state transitions for a designated cases.
Self-managed: the following states are available for self-managed cases.
-
Submitted → Detection and Analysis
-
Detection and Analysis → Containment, Eradication, and Recovery
-
Detection and Analysis → Post-incident Activities
-
Containment, Eradication, and Recovery → Detection and Analysis
-
Containment, Eradication, and Recovery → Post-incident Activities
-
Post-incident Activities → Containment, Eradication, and Recovery
-
Post-incident Activities → Detection and Analysis
-
Any → Closed
AWS supported: You must use the
CloseCase
API to close.
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) Updates 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) Updates 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) Updates the resolver type for a case.
This is a one-way action and cannot be reversed.
- 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) Updates the resolver type for a case.
This is a one-way action and cannot be reversed.
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
.
-