Interface SsmContactsClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SsmContactsClient extends AwsClient
Service client for accessing SSM Contacts. This can be created using the staticbuilder()method.Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptPage
default AcceptPageResponse acceptPage(AcceptPageRequest acceptPageRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Used to acknowledge an engagement to a contact channel during an incident.
- Parameters:
acceptPageRequest-- Returns:
- Result of the AcceptPage operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
acceptPage
default AcceptPageResponse acceptPage(Consumer<AcceptPageRequest.Builder> acceptPageRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Used to acknowledge an engagement to a contact channel during an incident.
This is a convenience which creates an instance of the
AcceptPageRequest.Builderavoiding the need to create one manually viaAcceptPageRequest.builder()- Parameters:
acceptPageRequest- AConsumerthat will call methods onAcceptPageRequest.Builderto create a request.- Returns:
- Result of the AcceptPage operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
activateContactChannel
default ActivateContactChannelResponse activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
- Parameters:
activateContactChannelRequest-- Returns:
- Result of the ActivateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
activateContactChannel
default ActivateContactChannelResponse activateContactChannel(Consumer<ActivateContactChannelRequest.Builder> activateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
This is a convenience which creates an instance of the
ActivateContactChannelRequest.Builderavoiding the need to create one manually viaActivateContactChannelRequest.builder()- Parameters:
activateContactChannelRequest- AConsumerthat will call methods onActivateContactChannelRequest.Builderto create a request.- Returns:
- Result of the ActivateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createContact
default CreateContactResponse createContact(CreateContactRequest createContactRequest) throws AccessDeniedException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
- Parameters:
createContactRequest-- Returns:
- Result of the CreateContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.DataEncryptionException- The operation failed to due an encryption key error.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createContact
default CreateContactResponse createContact(Consumer<CreateContactRequest.Builder> createContactRequest) throws AccessDeniedException, ConflictException, InternalServerException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.
This is a convenience which creates an instance of the
CreateContactRequest.Builderavoiding the need to create one manually viaCreateContactRequest.builder()- Parameters:
createContactRequest- AConsumerthat will call methods onCreateContactRequest.Builderto create a request.- Returns:
- Result of the CreateContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.DataEncryptionException- The operation failed to due an encryption key error.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createContactChannel
default CreateContactChannelResponse createContactChannel(CreateContactChannelRequest createContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
A contact channel is the method that Incident Manager uses to engage your contact.
- Parameters:
createContactChannelRequest-- Returns:
- Result of the CreateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createContactChannel
default CreateContactChannelResponse createContactChannel(Consumer<CreateContactChannelRequest.Builder> createContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
A contact channel is the method that Incident Manager uses to engage your contact.
This is a convenience which creates an instance of the
CreateContactChannelRequest.Builderavoiding the need to create one manually viaCreateContactChannelRequest.builder()- Parameters:
createContactChannelRequest- AConsumerthat will call methods onCreateContactChannelRequest.Builderto create a request.- Returns:
- Result of the CreateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRotation
default CreateRotationResponse createRotation(CreateRotationRequest createRotationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Creates a rotation in an on-call schedule.
- Parameters:
createRotationRequest-- Returns:
- Result of the CreateRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRotation
default CreateRotationResponse createRotation(Consumer<CreateRotationRequest.Builder> createRotationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Creates a rotation in an on-call schedule.
This is a convenience which creates an instance of the
CreateRotationRequest.Builderavoiding the need to create one manually viaCreateRotationRequest.builder()- Parameters:
createRotationRequest- AConsumerthat will call methods onCreateRotationRequest.Builderto create a request.- Returns:
- Result of the CreateRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRotationOverride
default CreateRotationOverrideResponse createRotationOverride(CreateRotationOverrideRequest createRotationOverrideRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Creates an override for a rotation in an on-call schedule.
- Parameters:
createRotationOverrideRequest-- Returns:
- Result of the CreateRotationOverride operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createRotationOverride
default CreateRotationOverrideResponse createRotationOverride(Consumer<CreateRotationOverrideRequest.Builder> createRotationOverrideRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Creates an override for a rotation in an on-call schedule.
This is a convenience which creates an instance of the
CreateRotationOverrideRequest.Builderavoiding the need to create one manually viaCreateRotationOverrideRequest.builder()- Parameters:
createRotationOverrideRequest- AConsumerthat will call methods onCreateRotationOverrideRequest.Builderto create a request.- Returns:
- Result of the CreateRotationOverride operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deactivateContactChannel
default DeactivateContactChannelResponse deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
- Parameters:
deactivateContactChannelRequest-- Returns:
- Result of the DeactivateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deactivateContactChannel
default DeactivateContactChannelResponse deactivateContactChannel(Consumer<DeactivateContactChannelRequest.Builder> deactivateContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
This is a convenience which creates an instance of the
DeactivateContactChannelRequest.Builderavoiding the need to create one manually viaDeactivateContactChannelRequest.builder()- Parameters:
deactivateContactChannelRequest- AConsumerthat will call methods onDeactivateContactChannelRequest.Builderto create a request.- Returns:
- Result of the DeactivateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContact
default DeleteContactResponse deleteContact(DeleteContactRequest deleteContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.
- Parameters:
deleteContactRequest-- Returns:
- Result of the DeleteContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ConflictException- Updating or deleting a resource causes an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContact
default DeleteContactResponse deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ConflictException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.
This is a convenience which creates an instance of the
DeleteContactRequest.Builderavoiding the need to create one manually viaDeleteContactRequest.builder()- Parameters:
deleteContactRequest- AConsumerthat will call methods onDeleteContactRequest.Builderto create a request.- Returns:
- Result of the DeleteContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ConflictException- Updating or deleting a resource causes an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContactChannel
default DeleteContactChannelResponse deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.
- Parameters:
deleteContactChannelRequest-- Returns:
- Result of the DeleteContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContactChannel
default DeleteContactChannelResponse deleteContactChannel(Consumer<DeleteContactChannelRequest.Builder> deleteContactChannelRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.
This is a convenience which creates an instance of the
DeleteContactChannelRequest.Builderavoiding the need to create one manually viaDeleteContactChannelRequest.builder()- Parameters:
deleteContactChannelRequest- AConsumerthat will call methods onDeleteContactChannelRequest.Builderto create a request.- Returns:
- Result of the DeleteContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRotation
default DeleteRotationResponse deleteRotation(DeleteRotationRequest deleteRotationRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.
- Parameters:
deleteRotationRequest-- Returns:
- Result of the DeleteRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRotation
default DeleteRotationResponse deleteRotation(Consumer<DeleteRotationRequest.Builder> deleteRotationRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.
This is a convenience which creates an instance of the
DeleteRotationRequest.Builderavoiding the need to create one manually viaDeleteRotationRequest.builder()- Parameters:
deleteRotationRequest- AConsumerthat will call methods onDeleteRotationRequest.Builderto create a request.- Returns:
- Result of the DeleteRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRotationOverride
default DeleteRotationOverrideResponse deleteRotationOverride(DeleteRotationOverrideRequest deleteRotationOverrideRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Deletes an existing override for an on-call rotation.
- Parameters:
deleteRotationOverrideRequest-- Returns:
- Result of the DeleteRotationOverride operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRotationOverride
default DeleteRotationOverrideResponse deleteRotationOverride(Consumer<DeleteRotationOverrideRequest.Builder> deleteRotationOverrideRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Deletes an existing override for an on-call rotation.
This is a convenience which creates an instance of the
DeleteRotationOverrideRequest.Builderavoiding the need to create one manually viaDeleteRotationOverrideRequest.builder()- Parameters:
deleteRotationOverrideRequest- AConsumerthat will call methods onDeleteRotationOverrideRequest.Builderto create a request.- Returns:
- Result of the DeleteRotationOverride operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngagement
default DescribeEngagementResponse describeEngagement(DescribeEngagementRequest describeEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
- Parameters:
describeEngagementRequest-- Returns:
- Result of the DescribeEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEngagement
default DescribeEngagementResponse describeEngagement(Consumer<DescribeEngagementRequest.Builder> describeEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.
This is a convenience which creates an instance of the
DescribeEngagementRequest.Builderavoiding the need to create one manually viaDescribeEngagementRequest.builder()- Parameters:
describeEngagementRequest- AConsumerthat will call methods onDescribeEngagementRequest.Builderto create a request.- Returns:
- Result of the DescribeEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePage
default DescribePageResponse describePage(DescribePageRequest describePageRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists details of the engagement to a contact channel.
- Parameters:
describePageRequest-- Returns:
- Result of the DescribePage operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePage
default DescribePageResponse describePage(Consumer<DescribePageRequest.Builder> describePageRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists details of the engagement to a contact channel.
This is a convenience which creates an instance of the
DescribePageRequest.Builderavoiding the need to create one manually viaDescribePageRequest.builder()- Parameters:
describePageRequest- AConsumerthat will call methods onDescribePageRequest.Builderto create a request.- Returns:
- Result of the DescribePage operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContact
default GetContactResponse getContact(GetContactRequest getContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about the specified contact or escalation plan.
- Parameters:
getContactRequest-- Returns:
- Result of the GetContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.DataEncryptionException- The operation failed to due an encryption key error.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContact
default GetContactResponse getContact(Consumer<GetContactRequest.Builder> getContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about the specified contact or escalation plan.
This is a convenience which creates an instance of the
GetContactRequest.Builderavoiding the need to create one manually viaGetContactRequest.builder()- Parameters:
getContactRequest- AConsumerthat will call methods onGetContactRequest.Builderto create a request.- Returns:
- Result of the GetContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.DataEncryptionException- The operation failed to due an encryption key error.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContactChannel
default GetContactChannelResponse getContactChannel(GetContactChannelRequest getContactChannelRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
List details about a specific contact channel.
- Parameters:
getContactChannelRequest-- Returns:
- Result of the GetContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContactChannel
default GetContactChannelResponse getContactChannel(Consumer<GetContactChannelRequest.Builder> getContactChannelRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
List details about a specific contact channel.
This is a convenience which creates an instance of the
GetContactChannelRequest.Builderavoiding the need to create one manually viaGetContactChannelRequest.builder()- Parameters:
getContactChannelRequest- AConsumerthat will call methods onGetContactChannelRequest.Builderto create a request.- Returns:
- Result of the GetContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContactPolicy
default GetContactPolicyResponse getContactPolicy(GetContactPolicyRequest getContactPolicyRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves the resource policies attached to the specified contact or escalation plan.
- Parameters:
getContactPolicyRequest-- Returns:
- Result of the GetContactPolicy operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getContactPolicy
default GetContactPolicyResponse getContactPolicy(Consumer<GetContactPolicyRequest.Builder> getContactPolicyRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves the resource policies attached to the specified contact or escalation plan.
This is a convenience which creates an instance of the
GetContactPolicyRequest.Builderavoiding the need to create one manually viaGetContactPolicyRequest.builder()- Parameters:
getContactPolicyRequest- AConsumerthat will call methods onGetContactPolicyRequest.Builderto create a request.- Returns:
- Result of the GetContactPolicy operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRotation
default GetRotationResponse getRotation(GetRotationRequest getRotationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about an on-call rotation.
- Parameters:
getRotationRequest-- Returns:
- Result of the GetRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRotation
default GetRotationResponse getRotation(Consumer<GetRotationRequest.Builder> getRotationRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about an on-call rotation.
This is a convenience which creates an instance of the
GetRotationRequest.Builderavoiding the need to create one manually viaGetRotationRequest.builder()- Parameters:
getRotationRequest- AConsumerthat will call methods onGetRotationRequest.Builderto create a request.- Returns:
- Result of the GetRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRotationOverride
default GetRotationOverrideResponse getRotationOverride(GetRotationOverrideRequest getRotationOverrideRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about an override to an on-call rotation.
- Parameters:
getRotationOverrideRequest-- Returns:
- Result of the GetRotationOverride operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getRotationOverride
default GetRotationOverrideResponse getRotationOverride(Consumer<GetRotationOverrideRequest.Builder> getRotationOverrideRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves information about an override to an on-call rotation.
This is a convenience which creates an instance of the
GetRotationOverrideRequest.Builderavoiding the need to create one manually viaGetRotationOverrideRequest.builder()- Parameters:
getRotationOverrideRequest- AConsumerthat will call methods onGetRotationOverrideRequest.Builderto create a request.- Returns:
- Result of the GetRotationOverride operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContactChannels
default ListContactChannelsResponse listContactChannels(ListContactChannelsRequest listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contact channels for the specified contact.
- Parameters:
listContactChannelsRequest-- Returns:
- Result of the ListContactChannels operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContactChannels
default ListContactChannelsResponse listContactChannels(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contact channels for the specified contact.
This is a convenience which creates an instance of the
ListContactChannelsRequest.Builderavoiding the need to create one manually viaListContactChannelsRequest.builder()- Parameters:
listContactChannelsRequest- AConsumerthat will call methods onListContactChannelsRequest.Builderto create a request.- Returns:
- Result of the ListContactChannels operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContactChannelsPaginator
default ListContactChannelsIterable listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client .listContactChannelsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(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
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)operation.- Parameters:
listContactChannelsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContactChannelsPaginator
default ListContactChannelsIterable listContactChannelsPaginator(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client .listContactChannelsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsIterable responses = client.listContactChannelsPaginator(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
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)operation.
This is a convenience which creates an instance of the
ListContactChannelsRequest.Builderavoiding the need to create one manually viaListContactChannelsRequest.builder()- Parameters:
listContactChannelsRequest- AConsumerthat will call methods onListContactChannelsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContacts
default ListContactsResponse listContacts(ListContactsRequest listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contacts and escalation plans in Incident Manager.
- Parameters:
listContactsRequest-- Returns:
- Result of the ListContacts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContacts
default ListContactsResponse listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all contacts and escalation plans in Incident Manager.
This is a convenience which creates an instance of the
ListContactsRequest.Builderavoiding the need to create one manually viaListContactsRequest.builder()- Parameters:
listContactsRequest- AConsumerthat will call methods onListContactsRequest.Builderto create a request.- Returns:
- Result of the ListContacts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContactsPaginator
default ListContactsIterable listContactsPaginator(ListContactsRequest listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(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
listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)operation.- Parameters:
listContactsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listContactsPaginator
default ListContactsIterable listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListContactsIterable responses = client.listContactsPaginator(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
listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)operation.
This is a convenience which creates an instance of the
ListContactsRequest.Builderavoiding the need to create one manually viaListContactsRequest.builder()- Parameters:
listContactsRequest- AConsumerthat will call methods onListContactsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEngagements
default ListEngagementsResponse listEngagements(ListEngagementsRequest listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all engagements that have happened in an incident.
- Parameters:
listEngagementsRequest-- Returns:
- Result of the ListEngagements operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEngagements
default ListEngagementsResponse listEngagements(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all engagements that have happened in an incident.
This is a convenience which creates an instance of the
ListEngagementsRequest.Builderavoiding the need to create one manually viaListEngagementsRequest.builder()- Parameters:
listEngagementsRequest- AConsumerthat will call methods onListEngagementsRequest.Builderto create a request.- Returns:
- Result of the ListEngagements operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEngagementsPaginator
default ListEngagementsIterable listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client .listEngagementsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(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
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest)operation.- Parameters:
listEngagementsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listEngagementsPaginator
default ListEngagementsIterable listEngagementsPaginator(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client .listEngagementsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsIterable responses = client.listEngagementsPaginator(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
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest)operation.
This is a convenience which creates an instance of the
ListEngagementsRequest.Builderavoiding the need to create one manually viaListEngagementsRequest.builder()- Parameters:
listEngagementsRequest- AConsumerthat will call methods onListEngagementsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageReceipts
default ListPageReceiptsResponse listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all of the engagements to contact channels that have been acknowledged.
- Parameters:
listPageReceiptsRequest-- Returns:
- Result of the ListPageReceipts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageReceipts
default ListPageReceiptsResponse listPageReceipts(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists all of the engagements to contact channels that have been acknowledged.
This is a convenience which creates an instance of the
ListPageReceiptsRequest.Builderavoiding the need to create one manually viaListPageReceiptsRequest.builder()- Parameters:
listPageReceiptsRequest- AConsumerthat will call methods onListPageReceiptsRequest.Builderto create a request.- Returns:
- Result of the ListPageReceipts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageReceiptsPaginator
default ListPageReceiptsIterable listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client .listPageReceiptsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(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
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest)operation.- Parameters:
listPageReceiptsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageReceiptsPaginator
default ListPageReceiptsIterable listPageReceiptsPaginator(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client .listPageReceiptsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsIterable responses = client.listPageReceiptsPaginator(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
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest)operation.
This is a convenience which creates an instance of the
ListPageReceiptsRequest.Builderavoiding the need to create one manually viaListPageReceiptsRequest.builder()- Parameters:
listPageReceiptsRequest- AConsumerthat will call methods onListPageReceiptsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageResolutions
default ListPageResolutionsResponse listPageResolutions(ListPageResolutionsRequest listPageResolutionsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.
- Parameters:
listPageResolutionsRequest-- Returns:
- Result of the ListPageResolutions operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageResolutions
default ListPageResolutionsResponse listPageResolutions(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.
This is a convenience which creates an instance of the
ListPageResolutionsRequest.Builderavoiding the need to create one manually viaListPageResolutionsRequest.builder()- Parameters:
listPageResolutionsRequest- AConsumerthat will call methods onListPageResolutionsRequest.Builderto create a request.- Returns:
- Result of the ListPageResolutions operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageResolutionsPaginator
default ListPageResolutionsIterable listPageResolutionsPaginator(ListPageResolutionsRequest listPageResolutionsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client .listPageResolutionsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null 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
listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest)operation.- Parameters:
listPageResolutionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPageResolutionsPaginator
default ListPageResolutionsIterable listPageResolutionsPaginator(Consumer<ListPageResolutionsRequest.Builder> listPageResolutionsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client .listPageResolutionsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPageResolutionsIterable responses = client.listPageResolutionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of null 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
listPageResolutions(software.amazon.awssdk.services.ssmcontacts.model.ListPageResolutionsRequest)operation.
This is a convenience which creates an instance of the
ListPageResolutionsRequest.Builderavoiding the need to create one manually viaListPageResolutionsRequest.builder()- Parameters:
listPageResolutionsRequest- AConsumerthat will call methods onListPageResolutionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByContact
default ListPagesByContactResponse listPagesByContact(ListPagesByContactRequest listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to a contact's contact channels.
- Parameters:
listPagesByContactRequest-- Returns:
- Result of the ListPagesByContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByContact
default ListPagesByContactResponse listPagesByContact(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to a contact's contact channels.
This is a convenience which creates an instance of the
ListPagesByContactRequest.Builderavoiding the need to create one manually viaListPagesByContactRequest.builder()- Parameters:
listPagesByContactRequest- AConsumerthat will call methods onListPagesByContactRequest.Builderto create a request.- Returns:
- Result of the ListPagesByContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByContactPaginator
default ListPagesByContactIterable listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client .listPagesByContactPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(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
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)operation.- Parameters:
listPagesByContactRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByContactPaginator
default ListPagesByContactIterable listPagesByContactPaginator(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client .listPagesByContactPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactIterable responses = client.listPagesByContactPaginator(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
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)operation.
This is a convenience which creates an instance of the
ListPagesByContactRequest.Builderavoiding the need to create one manually viaListPagesByContactRequest.builder()- Parameters:
listPagesByContactRequest- AConsumerthat will call methods onListPagesByContactRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByEngagement
default ListPagesByEngagementResponse listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to contact channels that occurred by engaging a contact.
- Parameters:
listPagesByEngagementRequest-- Returns:
- Result of the ListPagesByEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByEngagement
default ListPagesByEngagementResponse listPagesByEngagement(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Lists the engagements to contact channels that occurred by engaging a contact.
This is a convenience which creates an instance of the
ListPagesByEngagementRequest.Builderavoiding the need to create one manually viaListPagesByEngagementRequest.builder()- Parameters:
listPagesByEngagementRequest- AConsumerthat will call methods onListPagesByEngagementRequest.Builderto create a request.- Returns:
- Result of the ListPagesByEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByEngagementPaginator
default ListPagesByEngagementIterable listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client .listPagesByEngagementPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(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
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)operation.- Parameters:
listPagesByEngagementRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPagesByEngagementPaginator
default ListPagesByEngagementIterable listPagesByEngagementPaginator(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client .listPagesByEngagementPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementIterable responses = client.listPagesByEngagementPaginator(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
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)operation.
This is a convenience which creates an instance of the
ListPagesByEngagementRequest.Builderavoiding the need to create one manually viaListPagesByEngagementRequest.builder()- Parameters:
listPagesByEngagementRequest- AConsumerthat will call methods onListPagesByEngagementRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPreviewRotationShifts
default ListPreviewRotationShiftsResponse listPreviewRotationShifts(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Returns a list of shifts based on rotation configuration parameters.
The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.
- Parameters:
listPreviewRotationShiftsRequest-- Returns:
- Result of the ListPreviewRotationShifts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPreviewRotationShifts
default ListPreviewRotationShiftsResponse listPreviewRotationShifts(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Returns a list of shifts based on rotation configuration parameters.
The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.
This is a convenience which creates an instance of the
ListPreviewRotationShiftsRequest.Builderavoiding the need to create one manually viaListPreviewRotationShiftsRequest.builder()- Parameters:
listPreviewRotationShiftsRequest- AConsumerthat will call methods onListPreviewRotationShiftsRequest.Builderto create a request.- Returns:
- Result of the ListPreviewRotationShifts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPreviewRotationShiftsPaginator
default ListPreviewRotationShiftsIterable listPreviewRotationShiftsPaginator(ListPreviewRotationShiftsRequest listPreviewRotationShiftsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client .listPreviewRotationShiftsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(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
listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest)operation.- Parameters:
listPreviewRotationShiftsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listPreviewRotationShiftsPaginator
default ListPreviewRotationShiftsIterable listPreviewRotationShiftsPaginator(Consumer<ListPreviewRotationShiftsRequest.Builder> listPreviewRotationShiftsRequest) throws AccessDeniedException, InternalServerException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client .listPreviewRotationShiftsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListPreviewRotationShiftsIterable responses = client.listPreviewRotationShiftsPaginator(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
listPreviewRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListPreviewRotationShiftsRequest)operation.
This is a convenience which creates an instance of the
ListPreviewRotationShiftsRequest.Builderavoiding the need to create one manually viaListPreviewRotationShiftsRequest.builder()- Parameters:
listPreviewRotationShiftsRequest- AConsumerthat will call methods onListPreviewRotationShiftsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationOverrides
default ListRotationOverridesResponse listRotationOverrides(ListRotationOverridesRequest listRotationOverridesRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves a list of overrides currently specified for an on-call rotation.
- Parameters:
listRotationOverridesRequest-- Returns:
- Result of the ListRotationOverrides operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationOverrides
default ListRotationOverridesResponse listRotationOverrides(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves a list of overrides currently specified for an on-call rotation.
This is a convenience which creates an instance of the
ListRotationOverridesRequest.Builderavoiding the need to create one manually viaListRotationOverridesRequest.builder()- Parameters:
listRotationOverridesRequest- AConsumerthat will call methods onListRotationOverridesRequest.Builderto create a request.- Returns:
- Result of the ListRotationOverrides operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationOverridesPaginator
default ListRotationOverridesIterable listRotationOverridesPaginator(ListRotationOverridesRequest listRotationOverridesRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client .listRotationOverridesPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(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
listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest)operation.- Parameters:
listRotationOverridesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationOverridesPaginator
default ListRotationOverridesIterable listRotationOverridesPaginator(Consumer<ListRotationOverridesRequest.Builder> listRotationOverridesRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client .listRotationOverridesPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationOverridesIterable responses = client.listRotationOverridesPaginator(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
listRotationOverrides(software.amazon.awssdk.services.ssmcontacts.model.ListRotationOverridesRequest)operation.
This is a convenience which creates an instance of the
ListRotationOverridesRequest.Builderavoiding the need to create one manually viaListRotationOverridesRequest.builder()- Parameters:
listRotationOverridesRequest- AConsumerthat will call methods onListRotationOverridesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationShifts
default ListRotationShiftsResponse listRotationShifts(ListRotationShiftsRequest listRotationShiftsRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Returns a list of shifts generated by an existing rotation in the system.
- Parameters:
listRotationShiftsRequest-- Returns:
- Result of the ListRotationShifts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationShifts
default ListRotationShiftsResponse listRotationShifts(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Returns a list of shifts generated by an existing rotation in the system.
This is a convenience which creates an instance of the
ListRotationShiftsRequest.Builderavoiding the need to create one manually viaListRotationShiftsRequest.builder()- Parameters:
listRotationShiftsRequest- AConsumerthat will call methods onListRotationShiftsRequest.Builderto create a request.- Returns:
- Result of the ListRotationShifts operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationShiftsPaginator
default ListRotationShiftsIterable listRotationShiftsPaginator(ListRotationShiftsRequest listRotationShiftsRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client .listRotationShiftsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(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
listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest)operation.- Parameters:
listRotationShiftsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationShiftsPaginator
default ListRotationShiftsIterable listRotationShiftsPaginator(Consumer<ListRotationShiftsRequest.Builder> listRotationShiftsRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client .listRotationShiftsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationShiftsIterable responses = client.listRotationShiftsPaginator(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
listRotationShifts(software.amazon.awssdk.services.ssmcontacts.model.ListRotationShiftsRequest)operation.
This is a convenience which creates an instance of the
ListRotationShiftsRequest.Builderavoiding the need to create one manually viaListRotationShiftsRequest.builder()- Parameters:
listRotationShiftsRequest- AConsumerthat will call methods onListRotationShiftsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotations
default ListRotationsResponse listRotations(ListRotationsRequest listRotationsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves a list of on-call rotations.
- Parameters:
listRotationsRequest-- Returns:
- Result of the ListRotations operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotations
default ListRotationsResponse listRotations(Consumer<ListRotationsRequest.Builder> listRotationsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Retrieves a list of on-call rotations.
This is a convenience which creates an instance of the
ListRotationsRequest.Builderavoiding the need to create one manually viaListRotationsRequest.builder()- Parameters:
listRotationsRequest- AConsumerthat will call methods onListRotationsRequest.Builderto create a request.- Returns:
- Result of the ListRotations operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationsPaginator
default ListRotationsIterable listRotationsPaginator(ListRotationsRequest listRotationsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client.listRotationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client .listRotationsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client.listRotationsPaginator(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
listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest)operation.- Parameters:
listRotationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
listRotationsPaginator
default ListRotationsIterable listRotationsPaginator(Consumer<ListRotationsRequest.Builder> listRotationsRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
This is a variant of
listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest)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
2) Using For loopsoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client.listRotationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client .listRotationsPaginator(request); for (software.amazon.awssdk.services.ssmcontacts.model.ListRotationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmcontacts.paginators.ListRotationsIterable responses = client.listRotationsPaginator(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
listRotations(software.amazon.awssdk.services.ssmcontacts.model.ListRotationsRequest)operation.
This is a convenience which creates an instance of the
ListRotationsRequest.Builderavoiding the need to create one manually viaListRotationsRequest.builder()- Parameters:
listRotationsRequest- AConsumerthat will call methods onListRotationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- 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 AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Lists the tags of an escalation plan or contact.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- Request references a resource that doesn't exist.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- 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 AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Lists the tags of an escalation plan or contact.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- Request references a resource that doesn't exist.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putContactPolicy
default PutContactPolicyResponse putContactPolicy(PutContactPolicyRequest putContactPolicyRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.
- Parameters:
putContactPolicyRequest-- Returns:
- Result of the PutContactPolicy operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putContactPolicy
default PutContactPolicyResponse putContactPolicy(Consumer<PutContactPolicyRequest.Builder> putContactPolicyRequest) throws AccessDeniedException, ConflictException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.
This is a convenience which creates an instance of the
PutContactPolicyRequest.Builderavoiding the need to create one manually viaPutContactPolicyRequest.builder()- Parameters:
putContactPolicyRequest- AConsumerthat will call methods onPutContactPolicyRequest.Builderto create a request.- Returns:
- Result of the PutContactPolicy operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
sendActivationCode
default SendActivationCodeResponse sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the
ActivateChanneloperation. Incident Manager can't engage a contact channel until it has been activated.- Parameters:
sendActivationCodeRequest-- Returns:
- Result of the SendActivationCode operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
sendActivationCode
default SendActivationCodeResponse sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the
ActivateChanneloperation. Incident Manager can't engage a contact channel until it has been activated.
This is a convenience which creates an instance of the
SendActivationCodeRequest.Builderavoiding the need to create one manually viaSendActivationCodeRequest.builder()- Parameters:
sendActivationCodeRequest- AConsumerthat will call methods onSendActivationCodeRequest.Builderto create a request.- Returns:
- Result of the SendActivationCode operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startEngagement
default StartEngagementResponse startEngagement(StartEngagementRequest startEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
- Parameters:
startEngagementRequest-- Returns:
- Result of the StartEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startEngagement
default StartEngagementResponse startEngagement(Consumer<StartEngagementRequest.Builder> startEngagementRequest) throws AccessDeniedException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
This is a convenience which creates an instance of the
StartEngagementRequest.Builderavoiding the need to create one manually viaStartEngagementRequest.builder()- Parameters:
startEngagementRequest- AConsumerthat will call methods onStartEngagementRequest.Builderto create a request.- Returns:
- Result of the StartEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopEngagement
default StopEngagementResponse stopEngagement(StopEngagementRequest stopEngagementRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
- Parameters:
stopEngagementRequest-- Returns:
- Result of the StopEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
stopEngagement
default StopEngagementResponse stopEngagement(Consumer<StopEngagementRequest.Builder> stopEngagementRequest) throws AccessDeniedException, ValidationException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
This is a convenience which creates an instance of the
StopEngagementRequest.Builderavoiding the need to create one manually viaStopEngagementRequest.builder()- Parameters:
stopEngagementRequest- AConsumerthat will call methods onStopEngagementRequest.Builderto create a request.- Returns:
- Result of the StopEngagement operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- 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 AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- Request references a resource that doesn't exist.InternalServerException- Unexpected error occurred while processing the request.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- 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 AccessDeniedException, ThrottlingException, ResourceNotFoundException, InternalServerException, ServiceQuotaExceededException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- Request references a resource that doesn't exist.InternalServerException- Unexpected error occurred while processing the request.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- 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 AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Removes tags from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- Request references a resource that doesn't exist.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- 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 AccessDeniedException, ThrottlingException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmContactsException
Removes tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ThrottlingException- The request was denied due to request throttling.ResourceNotFoundException- Request references a resource that doesn't exist.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.InternalServerException- Unexpected error occurred while processing the request.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateContact
default UpdateContactResponse updateContact(UpdateContactRequest updateContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Updates the contact or escalation plan specified.
- Parameters:
updateContactRequest-- Returns:
- Result of the UpdateContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.DataEncryptionException- The operation failed to due an encryption key error.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateContact
default UpdateContactResponse updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest) throws AccessDeniedException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, ThrottlingException, ValidationException, DataEncryptionException, AwsServiceException, SdkClientException, SsmContactsException
Updates the contact or escalation plan specified.
This is a convenience which creates an instance of the
UpdateContactRequest.Builderavoiding the need to create one manually viaUpdateContactRequest.builder()- Parameters:
updateContactRequest- AConsumerthat will call methods onUpdateContactRequest.Builderto create a request.- Returns:
- Result of the UpdateContact operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ServiceQuotaExceededException- Request would cause a service quota to be exceeded.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.DataEncryptionException- The operation failed to due an encryption key error.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateContactChannel
default UpdateContactChannelResponse updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Updates a contact's contact channel.
- Parameters:
updateContactChannelRequest-- Returns:
- Result of the UpdateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateContactChannel
default UpdateContactChannelResponse updateContactChannel(Consumer<UpdateContactChannelRequest.Builder> updateContactChannelRequest) throws AccessDeniedException, ConflictException, DataEncryptionException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Updates a contact's contact channel.
This is a convenience which creates an instance of the
UpdateContactChannelRequest.Builderavoiding the need to create one manually viaUpdateContactChannelRequest.builder()- Parameters:
updateContactChannelRequest- AConsumerthat will call methods onUpdateContactChannelRequest.Builderto create a request.- Returns:
- Result of the UpdateContactChannel operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.DataEncryptionException- The operation failed to due an encryption key error.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateRotation
default UpdateRotationResponse updateRotation(UpdateRotationRequest updateRotationRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Updates the information specified for an on-call rotation.
- Parameters:
updateRotationRequest-- Returns:
- Result of the UpdateRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateRotation
default UpdateRotationResponse updateRotation(Consumer<UpdateRotationRequest.Builder> updateRotationRequest) throws AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, SsmContactsException
Updates the information specified for an on-call rotation.
This is a convenience which creates an instance of the
UpdateRotationRequest.Builderavoiding the need to create one manually viaUpdateRotationRequest.builder()- Parameters:
updateRotationRequest- AConsumerthat will call methods onUpdateRotationRequest.Builderto create a request.- Returns:
- Result of the UpdateRotation operation returned by the service.
- Throws:
AccessDeniedException- You don't have sufficient access to perform this operation.ConflictException- Updating or deleting a resource causes an inconsistent state.InternalServerException- Unexpected error occurred while processing the request.ResourceNotFoundException- Request references a resource that doesn't exist.ThrottlingException- The request was denied due to request throttling.ValidationException- The input fails to satisfy the constraints specified by an Amazon Web Services service.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.SsmContactsException- 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 SsmContactsClient create()
Create aSsmContactsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SsmContactsClientBuilder builder()
Create a builder that can be used to configure and create aSsmContactsClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SsmContactsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-