Package software.amazon.awssdk.services.securityir

Interface SecurityIrClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface SecurityIrClient
extends AwsClient

Service client for accessing Security Incident Response. This can be created using the static builder() method.

This guide provides documents the action and response elements for customer use of the service.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchGetMemberAccountDetailsResponse	batchGetMemberAccountDetails(Consumer<BatchGetMemberAccountDetailsRequest.Builder> batchGetMemberAccountDetailsRequest)	Grants permission to view an existing membership.
default BatchGetMemberAccountDetailsResponse	batchGetMemberAccountDetails(BatchGetMemberAccountDetailsRequest batchGetMemberAccountDetailsRequest)	Grants permission to view an existing membership.
static SecurityIrClientBuilder	builder()	Create a builder that can be used to configure and create a SecurityIrClient.
default CancelMembershipResponse	cancelMembership(Consumer<CancelMembershipRequest.Builder> cancelMembershipRequest)	Grants permissions to cancel an existing membership.
default CancelMembershipResponse	cancelMembership(CancelMembershipRequest cancelMembershipRequest)	Grants permissions to cancel an existing membership.
default CloseCaseResponse	closeCase(Consumer<CloseCaseRequest.Builder> closeCaseRequest)	Grants permission to close an existing case.
default CloseCaseResponse	closeCase(CloseCaseRequest closeCaseRequest)	Grants permission to close an existing case.
static SecurityIrClient	create()	Create a SecurityIrClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateCaseResponse	createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)	Grants permission to create a new case.
default CreateCaseResponse	createCase(CreateCaseRequest createCaseRequest)	Grants permission to create a new case.
default CreateCaseCommentResponse	createCaseComment(Consumer<CreateCaseCommentRequest.Builder> createCaseCommentRequest)	Grants permission to add a comment to an existing case.
default CreateCaseCommentResponse	createCaseComment(CreateCaseCommentRequest createCaseCommentRequest)	Grants permission to add a comment to an existing case.
default CreateMembershipResponse	createMembership(Consumer<CreateMembershipRequest.Builder> createMembershipRequest)	Grants permissions to create a new membership.
default CreateMembershipResponse	createMembership(CreateMembershipRequest createMembershipRequest)	Grants permissions to create a new membership.
default GetCaseResponse	getCase(Consumer<GetCaseRequest.Builder> getCaseRequest)	Grant permission to view a designated case.
default GetCaseResponse	getCase(GetCaseRequest getCaseRequest)	Grant permission to view a designated case.
default GetCaseAttachmentDownloadUrlResponse	getCaseAttachmentDownloadUrl(Consumer<GetCaseAttachmentDownloadUrlRequest.Builder> getCaseAttachmentDownloadUrlRequest)	Grants permission to obtain an Amazon S3 presigned URL to download an attachment.
default GetCaseAttachmentDownloadUrlResponse	getCaseAttachmentDownloadUrl(GetCaseAttachmentDownloadUrlRequest getCaseAttachmentDownloadUrlRequest)	Grants permission to obtain an Amazon S3 presigned URL to download an attachment.
default GetCaseAttachmentUploadUrlResponse	getCaseAttachmentUploadUrl(Consumer<GetCaseAttachmentUploadUrlRequest.Builder> getCaseAttachmentUploadUrlRequest)	Grants permission to upload an attachment to a case.
default GetCaseAttachmentUploadUrlResponse	getCaseAttachmentUploadUrl(GetCaseAttachmentUploadUrlRequest getCaseAttachmentUploadUrlRequest)	Grants permission to upload an attachment to a case.
default GetMembershipResponse	getMembership(Consumer<GetMembershipRequest.Builder> getMembershipRequest)	Grants permission to get details of a designated service membership.
default GetMembershipResponse	getMembership(GetMembershipRequest getMembershipRequest)	Grants permission to get details of a designated service membership.
default ListCaseEditsResponse	listCaseEdits(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest)	Grants permissions to view the aidt log for edits made to a designated case.
default ListCaseEditsResponse	listCaseEdits(ListCaseEditsRequest listCaseEditsRequest)	Grants permissions to view the aidt log for edits made to a designated case.
default ListCaseEditsIterable	listCaseEditsPaginator(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest)	This is a variant of listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest) operation.
default ListCaseEditsIterable	listCaseEditsPaginator(ListCaseEditsRequest listCaseEditsRequest)	This is a variant of listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest) operation.
default ListCasesResponse	listCases(Consumer<ListCasesRequest.Builder> listCasesRequest)	Grants permission to list all cases the requester has access to.
default ListCasesResponse	listCases(ListCasesRequest listCasesRequest)	Grants permission to list all cases the requester has access to.
default ListCasesIterable	listCasesPaginator(Consumer<ListCasesRequest.Builder> listCasesRequest)	This is a variant of listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest) operation.
default ListCasesIterable	listCasesPaginator(ListCasesRequest listCasesRequest)	This is a variant of listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest) operation.
default ListCommentsResponse	listComments(Consumer<ListCommentsRequest.Builder> listCommentsRequest)	Grants permissions to list and view comments for a designated case.
default ListCommentsResponse	listComments(ListCommentsRequest listCommentsRequest)	Grants permissions to list and view comments for a designated case.
default ListCommentsIterable	listCommentsPaginator(Consumer<ListCommentsRequest.Builder> listCommentsRequest)	This is a variant of listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest) operation.
default ListCommentsIterable	listCommentsPaginator(ListCommentsRequest listCommentsRequest)	This is a variant of listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest) operation.
default ListMembershipsResponse	listMemberships(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest)	Grants permission to query the memberships a principal has access to.
default ListMembershipsResponse	listMemberships(ListMembershipsRequest listMembershipsRequest)	Grants permission to query the memberships a principal has access to.
default ListMembershipsIterable	listMembershipsPaginator(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest)	This is a variant of listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest) operation.
default ListMembershipsIterable	listMembershipsPaginator(ListMembershipsRequest listMembershipsRequest)	This is a variant of listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Grants permission to view currently configured tags on a resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Grants permission to view currently configured tags on a resource.
default SecurityIrServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Grants permission to add a tag(s) to a designated resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Grants permission to add a tag(s) to a designated resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Grants permission to remove a tag(s) from a designate resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Grants permission to remove a tag(s) from a designate resource.
default UpdateCaseResponse	updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest)	Grants permission to update an existing case.
default UpdateCaseResponse	updateCase(UpdateCaseRequest updateCaseRequest)	Grants permission to update an existing case.
default UpdateCaseCommentResponse	updateCaseComment(Consumer<UpdateCaseCommentRequest.Builder> updateCaseCommentRequest)	Grants permission to update an existing case comment.
default UpdateCaseCommentResponse	updateCaseComment(UpdateCaseCommentRequest updateCaseCommentRequest)	Grants permission to update an existing case comment.
default UpdateCaseStatusResponse	updateCaseStatus(Consumer<UpdateCaseStatusRequest.Builder> updateCaseStatusRequest)	Grants permission to update the status for a designated cases.
default UpdateCaseStatusResponse	updateCaseStatus(UpdateCaseStatusRequest updateCaseStatusRequest)	Grants permission to update the status for a designated cases.
default UpdateMembershipResponse	updateMembership(Consumer<UpdateMembershipRequest.Builder> updateMembershipRequest)	Grants access to UpdateMembership to change membership configuration.
default UpdateMembershipResponse	updateMembership(UpdateMembershipRequest updateMembershipRequest)	Grants access to UpdateMembership to change membership configuration.
default UpdateResolverTypeResponse	updateResolverType(Consumer<UpdateResolverTypeRequest.Builder> updateResolverTypeRequest)	Grants permission to update the resolver type for a case.
default UpdateResolverTypeResponse	updateResolverType(UpdateResolverTypeRequest updateResolverTypeRequest)	Grants permission to update the resolver type for a case.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

batchGetMemberAccountDetails

default BatchGetMemberAccountDetailsResponse batchGetMemberAccountDetails(BatchGetMemberAccountDetailsRequest batchGetMemberAccountDetailsRequest)
                                                                   throws ServiceQuotaExceededException,
                                                                          AccessDeniedException,
                                                                          ValidationException,
                                                                          SecurityIncidentResponseNotActiveException,
                                                                          InternalServerException,
                                                                          ConflictException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          InvalidTokenException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          SecurityIrException

Grants permission to view an existing membership.

Parameters:

batchGetMemberAccountDetailsRequest -

Returns:

Result of the BatchGetMemberAccountDetails operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

batchGetMemberAccountDetails

default BatchGetMemberAccountDetailsResponse batchGetMemberAccountDetails(Consumer<BatchGetMemberAccountDetailsRequest.Builder> batchGetMemberAccountDetailsRequest)
                                                                   throws ServiceQuotaExceededException,
                                                                          AccessDeniedException,
                                                                          ValidationException,
                                                                          SecurityIncidentResponseNotActiveException,
                                                                          InternalServerException,
                                                                          ConflictException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          InvalidTokenException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          SecurityIrException

Grants permission to view an existing membership.

This is a convenience which creates an instance of the BatchGetMemberAccountDetailsRequest.Builder avoiding the need to create one manually via BatchGetMemberAccountDetailsRequest.builder()

Parameters:

batchGetMemberAccountDetailsRequest - A Consumer that will call methods on BatchGetMemberAccountDetailsRequest.Builder to create a request.

Returns:

Result of the BatchGetMemberAccountDetails operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

cancelMembership

default CancelMembershipResponse cancelMembership(CancelMembershipRequest cancelMembershipRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants permissions to cancel an existing membership.

Parameters:

cancelMembershipRequest -

Returns:

Result of the CancelMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

cancelMembership

default CancelMembershipResponse cancelMembership(Consumer<CancelMembershipRequest.Builder> cancelMembershipRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants permissions to cancel an existing membership.

This is a convenience which creates an instance of the CancelMembershipRequest.Builder avoiding the need to create one manually via CancelMembershipRequest.builder()

Parameters:

cancelMembershipRequest - A Consumer that will call methods on CancelMembershipRequest.Builder to create a request.

Returns:

Result of the CancelMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

closeCase

default CloseCaseResponse closeCase(CloseCaseRequest closeCaseRequest)
                             throws ServiceQuotaExceededException,
                                    AccessDeniedException,
                                    ValidationException,
                                    SecurityIncidentResponseNotActiveException,
                                    InternalServerException,
                                    ConflictException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InvalidTokenException,
                                    AwsServiceException,
                                    SdkClientException,
                                    SecurityIrException

Grants permission to close an existing case.

Parameters:

closeCaseRequest -

Returns:

Result of the CloseCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

closeCase

default CloseCaseResponse closeCase(Consumer<CloseCaseRequest.Builder> closeCaseRequest)
                             throws ServiceQuotaExceededException,
                                    AccessDeniedException,
                                    ValidationException,
                                    SecurityIncidentResponseNotActiveException,
                                    InternalServerException,
                                    ConflictException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InvalidTokenException,
                                    AwsServiceException,
                                    SdkClientException,
                                    SecurityIrException

Grants permission to close an existing case.

This is a convenience which creates an instance of the CloseCaseRequest.Builder avoiding the need to create one manually via CloseCaseRequest.builder()

Parameters:

closeCaseRequest - A Consumer that will call methods on CloseCaseRequest.Builder to create a request.

Returns:

Result of the CloseCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

createCase

default CreateCaseResponse createCase(CreateCaseRequest createCaseRequest)
                               throws ServiceQuotaExceededException,
                                      AccessDeniedException,
                                      ValidationException,
                                      SecurityIncidentResponseNotActiveException,
                                      InternalServerException,
                                      ConflictException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InvalidTokenException,
                                      AwsServiceException,
                                      SdkClientException,
                                      SecurityIrException

Grants permission to create a new case.

Parameters:

createCaseRequest -

Returns:

Result of the CreateCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

createCase

default CreateCaseResponse createCase(Consumer<CreateCaseRequest.Builder> createCaseRequest)
                               throws ServiceQuotaExceededException,
                                      AccessDeniedException,
                                      ValidationException,
                                      SecurityIncidentResponseNotActiveException,
                                      InternalServerException,
                                      ConflictException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InvalidTokenException,
                                      AwsServiceException,
                                      SdkClientException,
                                      SecurityIrException

Grants permission to create a new case.

This is a convenience which creates an instance of the CreateCaseRequest.Builder avoiding the need to create one manually via CreateCaseRequest.builder()

Parameters:

createCaseRequest - A Consumer that will call methods on CreateCaseRequest.Builder to create a request.

Returns:

Result of the CreateCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

createCaseComment

default CreateCaseCommentResponse createCaseComment(CreateCaseCommentRequest createCaseCommentRequest)
                                             throws ServiceQuotaExceededException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    SecurityIncidentResponseNotActiveException,
                                                    InternalServerException,
                                                    ConflictException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InvalidTokenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecurityIrException

Grants permission to add a comment to an existing case.

Parameters:

createCaseCommentRequest -

Returns:

Result of the CreateCaseComment operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

createCaseComment

default CreateCaseCommentResponse createCaseComment(Consumer<CreateCaseCommentRequest.Builder> createCaseCommentRequest)
                                             throws ServiceQuotaExceededException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    SecurityIncidentResponseNotActiveException,
                                                    InternalServerException,
                                                    ConflictException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InvalidTokenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecurityIrException

Grants permission to add a comment to an existing case.

This is a convenience which creates an instance of the CreateCaseCommentRequest.Builder avoiding the need to create one manually via CreateCaseCommentRequest.builder()

Parameters:

createCaseCommentRequest - A Consumer that will call methods on CreateCaseCommentRequest.Builder to create a request.

Returns:

Result of the CreateCaseComment operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

createMembership

default CreateMembershipResponse createMembership(CreateMembershipRequest createMembershipRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants permissions to create a new membership.

Parameters:

createMembershipRequest -

Returns:

Result of the CreateMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

createMembership

default CreateMembershipResponse createMembership(Consumer<CreateMembershipRequest.Builder> createMembershipRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants permissions to create a new membership.

This is a convenience which creates an instance of the CreateMembershipRequest.Builder avoiding the need to create one manually via CreateMembershipRequest.builder()

Parameters:

createMembershipRequest - A Consumer that will call methods on CreateMembershipRequest.Builder to create a request.

Returns:

Result of the CreateMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getCase

default GetCaseResponse getCase(GetCaseRequest getCaseRequest)
                         throws ServiceQuotaExceededException,
                                AccessDeniedException,
                                ValidationException,
                                SecurityIncidentResponseNotActiveException,
                                InternalServerException,
                                ConflictException,
                                ResourceNotFoundException,
                                ThrottlingException,
                                InvalidTokenException,
                                AwsServiceException,
                                SdkClientException,
                                SecurityIrException

Grant permission to view a designated case.

Parameters:

getCaseRequest -

Returns:

Result of the GetCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getCase

default GetCaseResponse getCase(Consumer<GetCaseRequest.Builder> getCaseRequest)
                         throws ServiceQuotaExceededException,
                                AccessDeniedException,
                                ValidationException,
                                SecurityIncidentResponseNotActiveException,
                                InternalServerException,
                                ConflictException,
                                ResourceNotFoundException,
                                ThrottlingException,
                                InvalidTokenException,
                                AwsServiceException,
                                SdkClientException,
                                SecurityIrException

Grant permission to view a designated case.

This is a convenience which creates an instance of the GetCaseRequest.Builder avoiding the need to create one manually via GetCaseRequest.builder()

Parameters:

getCaseRequest - A Consumer that will call methods on GetCaseRequest.Builder to create a request.

Returns:

Result of the GetCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getCaseAttachmentDownloadUrl

default GetCaseAttachmentDownloadUrlResponse getCaseAttachmentDownloadUrl(GetCaseAttachmentDownloadUrlRequest getCaseAttachmentDownloadUrlRequest)
                                                                   throws ServiceQuotaExceededException,
                                                                          AccessDeniedException,
                                                                          ValidationException,
                                                                          SecurityIncidentResponseNotActiveException,
                                                                          InternalServerException,
                                                                          ConflictException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          InvalidTokenException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          SecurityIrException

Grants permission to obtain an Amazon S3 presigned URL to download an attachment.

Parameters:

getCaseAttachmentDownloadUrlRequest -

Returns:

Result of the GetCaseAttachmentDownloadUrl operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getCaseAttachmentDownloadUrl

default GetCaseAttachmentDownloadUrlResponse getCaseAttachmentDownloadUrl(Consumer<GetCaseAttachmentDownloadUrlRequest.Builder> getCaseAttachmentDownloadUrlRequest)
                                                                   throws ServiceQuotaExceededException,
                                                                          AccessDeniedException,
                                                                          ValidationException,
                                                                          SecurityIncidentResponseNotActiveException,
                                                                          InternalServerException,
                                                                          ConflictException,
                                                                          ResourceNotFoundException,
                                                                          ThrottlingException,
                                                                          InvalidTokenException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          SecurityIrException

Grants permission to obtain an Amazon S3 presigned URL to download an attachment.

This is a convenience which creates an instance of the GetCaseAttachmentDownloadUrlRequest.Builder avoiding the need to create one manually via GetCaseAttachmentDownloadUrlRequest.builder()

Parameters:

getCaseAttachmentDownloadUrlRequest - A Consumer that will call methods on GetCaseAttachmentDownloadUrlRequest.Builder to create a request.

Returns:

Result of the GetCaseAttachmentDownloadUrl operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getCaseAttachmentUploadUrl

default GetCaseAttachmentUploadUrlResponse getCaseAttachmentUploadUrl(GetCaseAttachmentUploadUrlRequest getCaseAttachmentUploadUrlRequest)
                                                               throws ServiceQuotaExceededException,
                                                                      AccessDeniedException,
                                                                      ValidationException,
                                                                      SecurityIncidentResponseNotActiveException,
                                                                      InternalServerException,
                                                                      ConflictException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InvalidTokenException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      SecurityIrException

Grants permission to upload an attachment to a case.

Parameters:

getCaseAttachmentUploadUrlRequest -

Returns:

Result of the GetCaseAttachmentUploadUrl operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getCaseAttachmentUploadUrl

default GetCaseAttachmentUploadUrlResponse getCaseAttachmentUploadUrl(Consumer<GetCaseAttachmentUploadUrlRequest.Builder> getCaseAttachmentUploadUrlRequest)
                                                               throws ServiceQuotaExceededException,
                                                                      AccessDeniedException,
                                                                      ValidationException,
                                                                      SecurityIncidentResponseNotActiveException,
                                                                      InternalServerException,
                                                                      ConflictException,
                                                                      ResourceNotFoundException,
                                                                      ThrottlingException,
                                                                      InvalidTokenException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      SecurityIrException

Grants permission to upload an attachment to a case.

This is a convenience which creates an instance of the GetCaseAttachmentUploadUrlRequest.Builder avoiding the need to create one manually via GetCaseAttachmentUploadUrlRequest.builder()

Parameters:

getCaseAttachmentUploadUrlRequest - A Consumer that will call methods on GetCaseAttachmentUploadUrlRequest.Builder to create a request.

Returns:

Result of the GetCaseAttachmentUploadUrl operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getMembership

default GetMembershipResponse getMembership(GetMembershipRequest getMembershipRequest)
                                     throws ServiceQuotaExceededException,
                                            AccessDeniedException,
                                            ValidationException,
                                            SecurityIncidentResponseNotActiveException,
                                            InternalServerException,
                                            ConflictException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InvalidTokenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecurityIrException

Grants permission to get details of a designated service membership.

Parameters:

getMembershipRequest -

Returns:

Result of the GetMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

getMembership

default GetMembershipResponse getMembership(Consumer<GetMembershipRequest.Builder> getMembershipRequest)
                                     throws ServiceQuotaExceededException,
                                            AccessDeniedException,
                                            ValidationException,
                                            SecurityIncidentResponseNotActiveException,
                                            InternalServerException,
                                            ConflictException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InvalidTokenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecurityIrException

Grants permission to get details of a designated service membership.

This is a convenience which creates an instance of the GetMembershipRequest.Builder avoiding the need to create one manually via GetMembershipRequest.builder()

Parameters:

getMembershipRequest - A Consumer that will call methods on GetMembershipRequest.Builder to create a request.

Returns:

Result of the GetMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCaseEdits

default ListCaseEditsResponse listCaseEdits(ListCaseEditsRequest listCaseEditsRequest)
                                     throws ServiceQuotaExceededException,
                                            AccessDeniedException,
                                            ValidationException,
                                            SecurityIncidentResponseNotActiveException,
                                            InternalServerException,
                                            ConflictException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InvalidTokenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecurityIrException

Grants permissions to view the aidt log for edits made to a designated case.

Parameters:

listCaseEditsRequest -

Returns:

Result of the ListCaseEdits operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCaseEdits

default ListCaseEditsResponse listCaseEdits(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest)
                                     throws ServiceQuotaExceededException,
                                            AccessDeniedException,
                                            ValidationException,
                                            SecurityIncidentResponseNotActiveException,
                                            InternalServerException,
                                            ConflictException,
                                            ResourceNotFoundException,
                                            ThrottlingException,
                                            InvalidTokenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecurityIrException

Grants permissions to view the aidt log for edits made to a designated case.

This is a convenience which creates an instance of the ListCaseEditsRequest.Builder avoiding the need to create one manually via ListCaseEditsRequest.builder()

Parameters:

listCaseEditsRequest - A Consumer that will call methods on ListCaseEditsRequest.Builder to create a request.

Returns:

Result of the ListCaseEdits operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCaseEditsPaginator

default ListCaseEditsIterable listCaseEditsPaginator(ListCaseEditsRequest listCaseEditsRequest)
                                              throws ServiceQuotaExceededException,
                                                     AccessDeniedException,
                                                     ValidationException,
                                                     SecurityIncidentResponseNotActiveException,
                                                     InternalServerException,
                                                     ConflictException,
                                                     ResourceNotFoundException,
                                                     ThrottlingException,
                                                     InvalidTokenException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     SecurityIrException

This is a variant of listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListCaseEditsIterable responses = client.listCaseEditsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListCaseEditsIterable responses = client
             .listCaseEditsPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListCaseEditsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListCaseEditsIterable responses = client.listCaseEditsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest) operation.

Parameters:

listCaseEditsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCaseEditsPaginator

default ListCaseEditsIterable listCaseEditsPaginator(Consumer<ListCaseEditsRequest.Builder> listCaseEditsRequest)
                                              throws ServiceQuotaExceededException,
                                                     AccessDeniedException,
                                                     ValidationException,
                                                     SecurityIncidentResponseNotActiveException,
                                                     InternalServerException,
                                                     ConflictException,
                                                     ResourceNotFoundException,
                                                     ThrottlingException,
                                                     InvalidTokenException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     SecurityIrException

This is a variant of listCaseEdits(software.amazon.awssdk.services.securityir.model.ListCaseEditsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListCaseEditsIterable responses = client.listCaseEditsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListCaseEditsIterable responses = client
             .listCaseEditsPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListCaseEditsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListCaseEditsIterable responses = client.listCaseEditsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 via ListCaseEditsRequest.builder()

Parameters:

listCaseEditsRequest - A Consumer that will call methods on ListCaseEditsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCases

default ListCasesResponse listCases(ListCasesRequest listCasesRequest)
                             throws ServiceQuotaExceededException,
                                    AccessDeniedException,
                                    ValidationException,
                                    SecurityIncidentResponseNotActiveException,
                                    InternalServerException,
                                    ConflictException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InvalidTokenException,
                                    AwsServiceException,
                                    SdkClientException,
                                    SecurityIrException

Grants permission to list all cases the requester has access to.

Parameters:

listCasesRequest -

Returns:

Result of the ListCases operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCases

default ListCasesResponse listCases(Consumer<ListCasesRequest.Builder> listCasesRequest)
                             throws ServiceQuotaExceededException,
                                    AccessDeniedException,
                                    ValidationException,
                                    SecurityIncidentResponseNotActiveException,
                                    InternalServerException,
                                    ConflictException,
                                    ResourceNotFoundException,
                                    ThrottlingException,
                                    InvalidTokenException,
                                    AwsServiceException,
                                    SdkClientException,
                                    SecurityIrException

Grants permission to list all cases the requester has access to.

This is a convenience which creates an instance of the ListCasesRequest.Builder avoiding the need to create one manually via ListCasesRequest.builder()

Parameters:

listCasesRequest - A Consumer that will call methods on ListCasesRequest.Builder to create a request.

Returns:

Result of the ListCases operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCasesPaginator

default ListCasesIterable listCasesPaginator(ListCasesRequest listCasesRequest)
                                      throws ServiceQuotaExceededException,
                                             AccessDeniedException,
                                             ValidationException,
                                             SecurityIncidentResponseNotActiveException,
                                             InternalServerException,
                                             ConflictException,
                                             ResourceNotFoundException,
                                             ThrottlingException,
                                             InvalidTokenException,
                                             AwsServiceException,
                                             SdkClientException,
                                             SecurityIrException

This is a variant of listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListCasesIterable responses = client.listCasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListCasesIterable responses = client.listCasesPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListCasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListCasesIterable responses = client.listCasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest) operation.

Parameters:

listCasesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCasesPaginator

default ListCasesIterable listCasesPaginator(Consumer<ListCasesRequest.Builder> listCasesRequest)
                                      throws ServiceQuotaExceededException,
                                             AccessDeniedException,
                                             ValidationException,
                                             SecurityIncidentResponseNotActiveException,
                                             InternalServerException,
                                             ConflictException,
                                             ResourceNotFoundException,
                                             ThrottlingException,
                                             InvalidTokenException,
                                             AwsServiceException,
                                             SdkClientException,
                                             SecurityIrException

This is a variant of listCases(software.amazon.awssdk.services.securityir.model.ListCasesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListCasesIterable responses = client.listCasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListCasesIterable responses = client.listCasesPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListCasesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListCasesIterable responses = client.listCasesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 via ListCasesRequest.builder()

Parameters:

listCasesRequest - A Consumer that will call methods on ListCasesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listComments

default ListCommentsResponse listComments(ListCommentsRequest listCommentsRequest)
                                   throws ServiceQuotaExceededException,
                                          AccessDeniedException,
                                          ValidationException,
                                          SecurityIncidentResponseNotActiveException,
                                          InternalServerException,
                                          ConflictException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InvalidTokenException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecurityIrException

Grants permissions to list and view comments for a designated case.

Parameters:

listCommentsRequest -

Returns:

Result of the ListComments operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listComments

default ListCommentsResponse listComments(Consumer<ListCommentsRequest.Builder> listCommentsRequest)
                                   throws ServiceQuotaExceededException,
                                          AccessDeniedException,
                                          ValidationException,
                                          SecurityIncidentResponseNotActiveException,
                                          InternalServerException,
                                          ConflictException,
                                          ResourceNotFoundException,
                                          ThrottlingException,
                                          InvalidTokenException,
                                          AwsServiceException,
                                          SdkClientException,
                                          SecurityIrException

Grants permissions to list and view comments for a designated case.

This is a convenience which creates an instance of the ListCommentsRequest.Builder avoiding the need to create one manually via ListCommentsRequest.builder()

Parameters:

listCommentsRequest - A Consumer that will call methods on ListCommentsRequest.Builder to create a request.

Returns:

Result of the ListComments operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCommentsPaginator

default ListCommentsIterable listCommentsPaginator(ListCommentsRequest listCommentsRequest)
                                            throws ServiceQuotaExceededException,
                                                   AccessDeniedException,
                                                   ValidationException,
                                                   SecurityIncidentResponseNotActiveException,
                                                   InternalServerException,
                                                   ConflictException,
                                                   ResourceNotFoundException,
                                                   ThrottlingException,
                                                   InvalidTokenException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   SecurityIrException

This is a variant of listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListCommentsIterable responses = client.listCommentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListCommentsIterable responses = client.listCommentsPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListCommentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListCommentsIterable responses = client.listCommentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest) operation.

Parameters:

listCommentsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listCommentsPaginator

default ListCommentsIterable listCommentsPaginator(Consumer<ListCommentsRequest.Builder> listCommentsRequest)
                                            throws ServiceQuotaExceededException,
                                                   AccessDeniedException,
                                                   ValidationException,
                                                   SecurityIncidentResponseNotActiveException,
                                                   InternalServerException,
                                                   ConflictException,
                                                   ResourceNotFoundException,
                                                   ThrottlingException,
                                                   InvalidTokenException,
                                                   AwsServiceException,
                                                   SdkClientException,
                                                   SecurityIrException

This is a variant of listComments(software.amazon.awssdk.services.securityir.model.ListCommentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListCommentsIterable responses = client.listCommentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListCommentsIterable responses = client.listCommentsPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListCommentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListCommentsIterable responses = client.listCommentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 via ListCommentsRequest.builder()

Parameters:

listCommentsRequest - A Consumer that will call methods on ListCommentsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listMemberships

default ListMembershipsResponse listMemberships(ListMembershipsRequest listMembershipsRequest)
                                         throws ServiceQuotaExceededException,
                                                AccessDeniedException,
                                                ValidationException,
                                                SecurityIncidentResponseNotActiveException,
                                                InternalServerException,
                                                ConflictException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                InvalidTokenException,
                                                AwsServiceException,
                                                SdkClientException,
                                                SecurityIrException

Grants permission to query the memberships a principal has access to.

Parameters:

listMembershipsRequest -

Returns:

Result of the ListMemberships operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listMemberships

default ListMembershipsResponse listMemberships(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest)
                                         throws ServiceQuotaExceededException,
                                                AccessDeniedException,
                                                ValidationException,
                                                SecurityIncidentResponseNotActiveException,
                                                InternalServerException,
                                                ConflictException,
                                                ResourceNotFoundException,
                                                ThrottlingException,
                                                InvalidTokenException,
                                                AwsServiceException,
                                                SdkClientException,
                                                SecurityIrException

Grants permission to query the memberships a principal has access to.

This is a convenience which creates an instance of the ListMembershipsRequest.Builder avoiding the need to create one manually via ListMembershipsRequest.builder()

Parameters:

listMembershipsRequest - A Consumer that will call methods on ListMembershipsRequest.Builder to create a request.

Returns:

Result of the ListMemberships operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listMembershipsPaginator

default ListMembershipsIterable listMembershipsPaginator(ListMembershipsRequest listMembershipsRequest)
                                                  throws ServiceQuotaExceededException,
                                                         AccessDeniedException,
                                                         ValidationException,
                                                         SecurityIncidentResponseNotActiveException,
                                                         InternalServerException,
                                                         ConflictException,
                                                         ResourceNotFoundException,
                                                         ThrottlingException,
                                                         InvalidTokenException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         SecurityIrException

This is a variant of listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListMembershipsIterable responses = client
             .listMembershipsPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListMembershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest) operation.

Parameters:

listMembershipsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listMembershipsPaginator

default ListMembershipsIterable listMembershipsPaginator(Consumer<ListMembershipsRequest.Builder> listMembershipsRequest)
                                                  throws ServiceQuotaExceededException,
                                                         AccessDeniedException,
                                                         ValidationException,
                                                         SecurityIncidentResponseNotActiveException,
                                                         InternalServerException,
                                                         ConflictException,
                                                         ResourceNotFoundException,
                                                         ThrottlingException,
                                                         InvalidTokenException,
                                                         AwsServiceException,
                                                         SdkClientException,
                                                         SecurityIrException

This is a variant of listMemberships(software.amazon.awssdk.services.securityir.model.ListMembershipsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.securityir.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.securityir.paginators.ListMembershipsIterable responses = client
             .listMembershipsPaginator(request);
     for (software.amazon.awssdk.services.securityir.model.ListMembershipsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.securityir.paginators.ListMembershipsIterable responses = client.listMembershipsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the 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 via ListMembershipsRequest.builder()

Parameters:

listMembershipsRequest - A Consumer that will call methods on ListMembershipsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ServiceQuotaExceededException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        SecurityIncidentResponseNotActiveException,
                                                        InternalServerException,
                                                        ResourceNotFoundException,
                                                        ConflictException,
                                                        ThrottlingException,
                                                        InvalidTokenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        SecurityIrException

Grants permission to view currently configured tags on a resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ResourceNotFoundException

ConflictException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ServiceQuotaExceededException,
                                                        AccessDeniedException,
                                                        ValidationException,
                                                        SecurityIncidentResponseNotActiveException,
                                                        InternalServerException,
                                                        ResourceNotFoundException,
                                                        ConflictException,
                                                        ThrottlingException,
                                                        InvalidTokenException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        SecurityIrException

Grants permission to view currently configured tags on a resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ResourceNotFoundException

ConflictException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ServiceQuotaExceededException,
                                        AccessDeniedException,
                                        ValidationException,
                                        SecurityIncidentResponseNotActiveException,
                                        InternalServerException,
                                        ResourceNotFoundException,
                                        ConflictException,
                                        ThrottlingException,
                                        InvalidTokenException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SecurityIrException

Grants permission to add a tag(s) to a designated resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ResourceNotFoundException

ConflictException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ServiceQuotaExceededException,
                                        AccessDeniedException,
                                        ValidationException,
                                        SecurityIncidentResponseNotActiveException,
                                        InternalServerException,
                                        ResourceNotFoundException,
                                        ConflictException,
                                        ThrottlingException,
                                        InvalidTokenException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SecurityIrException

Grants permission to add a tag(s) to a designated resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ResourceNotFoundException

ConflictException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ServiceQuotaExceededException,
                                            AccessDeniedException,
                                            ValidationException,
                                            SecurityIncidentResponseNotActiveException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            ThrottlingException,
                                            InvalidTokenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecurityIrException

Grants permission to remove a tag(s) from a designate resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ResourceNotFoundException

ConflictException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ServiceQuotaExceededException,
                                            AccessDeniedException,
                                            ValidationException,
                                            SecurityIncidentResponseNotActiveException,
                                            InternalServerException,
                                            ResourceNotFoundException,
                                            ConflictException,
                                            ThrottlingException,
                                            InvalidTokenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            SecurityIrException

Grants permission to remove a tag(s) from a designate resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ResourceNotFoundException

ConflictException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateCase

default UpdateCaseResponse updateCase(UpdateCaseRequest updateCaseRequest)
                               throws ServiceQuotaExceededException,
                                      AccessDeniedException,
                                      ValidationException,
                                      SecurityIncidentResponseNotActiveException,
                                      InternalServerException,
                                      ConflictException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InvalidTokenException,
                                      AwsServiceException,
                                      SdkClientException,
                                      SecurityIrException

Grants permission to update an existing case.

Parameters:

updateCaseRequest -

Returns:

Result of the UpdateCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateCase

default UpdateCaseResponse updateCase(Consumer<UpdateCaseRequest.Builder> updateCaseRequest)
                               throws ServiceQuotaExceededException,
                                      AccessDeniedException,
                                      ValidationException,
                                      SecurityIncidentResponseNotActiveException,
                                      InternalServerException,
                                      ConflictException,
                                      ResourceNotFoundException,
                                      ThrottlingException,
                                      InvalidTokenException,
                                      AwsServiceException,
                                      SdkClientException,
                                      SecurityIrException

Grants permission to update an existing case.

This is a convenience which creates an instance of the UpdateCaseRequest.Builder avoiding the need to create one manually via UpdateCaseRequest.builder()

Parameters:

updateCaseRequest - A Consumer that will call methods on UpdateCaseRequest.Builder to create a request.

Returns:

Result of the UpdateCase operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateCaseComment

default UpdateCaseCommentResponse updateCaseComment(UpdateCaseCommentRequest updateCaseCommentRequest)
                                             throws ServiceQuotaExceededException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    SecurityIncidentResponseNotActiveException,
                                                    InternalServerException,
                                                    ConflictException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InvalidTokenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecurityIrException

Grants permission to update an existing case comment.

Parameters:

updateCaseCommentRequest -

Returns:

Result of the UpdateCaseComment operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateCaseComment

default UpdateCaseCommentResponse updateCaseComment(Consumer<UpdateCaseCommentRequest.Builder> updateCaseCommentRequest)
                                             throws ServiceQuotaExceededException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    SecurityIncidentResponseNotActiveException,
                                                    InternalServerException,
                                                    ConflictException,
                                                    ResourceNotFoundException,
                                                    ThrottlingException,
                                                    InvalidTokenException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    SecurityIrException

Grants permission to update an existing case comment.

This is a convenience which creates an instance of the UpdateCaseCommentRequest.Builder avoiding the need to create one manually via UpdateCaseCommentRequest.builder()

Parameters:

updateCaseCommentRequest - A Consumer that will call methods on UpdateCaseCommentRequest.Builder to create a request.

Returns:

Result of the UpdateCaseComment operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateCaseStatus

default UpdateCaseStatusResponse updateCaseStatus(UpdateCaseStatusRequest updateCaseStatusRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants permission to update the status for a designated cases. Options include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed .

Parameters:

updateCaseStatusRequest -

Returns:

Result of the UpdateCaseStatus operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateCaseStatus

default UpdateCaseStatusResponse updateCaseStatus(Consumer<UpdateCaseStatusRequest.Builder> updateCaseStatusRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants permission to update the status for a designated cases. Options include Submitted | Detection and Analysis | Eradication, Containment and Recovery | Post-Incident Activities | Closed .

This is a convenience which creates an instance of the UpdateCaseStatusRequest.Builder avoiding the need to create one manually via UpdateCaseStatusRequest.builder()

Parameters:

updateCaseStatusRequest - A Consumer that will call methods on UpdateCaseStatusRequest.Builder to create a request.

Returns:

Result of the UpdateCaseStatus operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateMembership

default UpdateMembershipResponse updateMembership(UpdateMembershipRequest updateMembershipRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants access to UpdateMembership to change membership configuration.

Parameters:

updateMembershipRequest -

Returns:

Result of the UpdateMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateMembership

default UpdateMembershipResponse updateMembership(Consumer<UpdateMembershipRequest.Builder> updateMembershipRequest)
                                           throws ServiceQuotaExceededException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  SecurityIncidentResponseNotActiveException,
                                                  InternalServerException,
                                                  ConflictException,
                                                  ResourceNotFoundException,
                                                  ThrottlingException,
                                                  InvalidTokenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  SecurityIrException

Grants access to UpdateMembership to change membership configuration.

This is a convenience which creates an instance of the UpdateMembershipRequest.Builder avoiding the need to create one manually via UpdateMembershipRequest.builder()

Parameters:

updateMembershipRequest - A Consumer that will call methods on UpdateMembershipRequest.Builder to create a request.

Returns:

Result of the UpdateMembership operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateResolverType

default UpdateResolverTypeResponse updateResolverType(UpdateResolverTypeRequest updateResolverTypeRequest)
                                               throws ServiceQuotaExceededException,
                                                      AccessDeniedException,
                                                      ValidationException,
                                                      SecurityIncidentResponseNotActiveException,
                                                      InternalServerException,
                                                      ConflictException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InvalidTokenException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      SecurityIrException

Grants permission to update the resolver type for a case.

This is a one-way action and cannot be reversed.

Options include self-supported > AWS-supported.

Parameters:

updateResolverTypeRequest -

Returns:

Result of the UpdateResolverType operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

updateResolverType

default UpdateResolverTypeResponse updateResolverType(Consumer<UpdateResolverTypeRequest.Builder> updateResolverTypeRequest)
                                               throws ServiceQuotaExceededException,
                                                      AccessDeniedException,
                                                      ValidationException,
                                                      SecurityIncidentResponseNotActiveException,
                                                      InternalServerException,
                                                      ConflictException,
                                                      ResourceNotFoundException,
                                                      ThrottlingException,
                                                      InvalidTokenException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      SecurityIrException

Grants permission to update the resolver type for a case.

This is a one-way action and cannot be reversed.

Options include self-supported > AWS-supported.

This is a convenience which creates an instance of the UpdateResolverTypeRequest.Builder avoiding the need to create one manually via UpdateResolverTypeRequest.builder()

Parameters:

updateResolverTypeRequest - A Consumer that will call methods on UpdateResolverTypeRequest.Builder to create a request.

Returns:

Result of the UpdateResolverType operation returned by the service.

Throws:

ServiceQuotaExceededException

AccessDeniedException

ValidationException

SecurityIncidentResponseNotActiveException

InternalServerException

ConflictException

ResourceNotFoundException

ThrottlingException

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.

AwsServiceException

See Also:

AWS API Documentation

create

static SecurityIrClient create()

Create a SecurityIrClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SecurityIrClientBuilder builder()

Create a builder that can be used to configure and create a SecurityIrClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SecurityIrServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient