@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SsmContactsAsyncClient extends SdkClient
builder()
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AcceptPageResponse> |
acceptPage(AcceptPageRequest acceptPageRequest)
Used to acknowledge an engagement to a contact channel during an incident.
|
default CompletableFuture<AcceptPageResponse> |
acceptPage(Consumer<AcceptPageRequest.Builder> acceptPageRequest)
Used to acknowledge an engagement to a contact channel during an incident.
|
default CompletableFuture<ActivateContactChannelResponse> |
activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest)
Activates a contact's contact channel.
|
default CompletableFuture<ActivateContactChannelResponse> |
activateContactChannel(Consumer<ActivateContactChannelRequest.Builder> activateContactChannelRequest)
Activates a contact's contact channel.
|
static SsmContactsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SsmContactsAsyncClient. |
static SsmContactsAsyncClient |
create()
Create a
SsmContactsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateContactResponse> |
createContact(Consumer<CreateContactRequest.Builder> createContactRequest)
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.
|
default CompletableFuture<CreateContactResponse> |
createContact(CreateContactRequest createContactRequest)
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.
|
default CompletableFuture<CreateContactChannelResponse> |
createContactChannel(Consumer<CreateContactChannelRequest.Builder> createContactChannelRequest)
A contact channel is the method that Incident Manager uses to engage your contact.
|
default CompletableFuture<CreateContactChannelResponse> |
createContactChannel(CreateContactChannelRequest createContactChannelRequest)
A contact channel is the method that Incident Manager uses to engage your contact.
|
default CompletableFuture<DeactivateContactChannelResponse> |
deactivateContactChannel(Consumer<DeactivateContactChannelRequest.Builder> deactivateContactChannelRequest)
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
|
default CompletableFuture<DeactivateContactChannelResponse> |
deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest)
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
|
default CompletableFuture<DeleteContactResponse> |
deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest)
To remove a contact from Incident Manager, you can delete the contact.
|
default CompletableFuture<DeleteContactResponse> |
deleteContact(DeleteContactRequest deleteContactRequest)
To remove a contact from Incident Manager, you can delete the contact.
|
default CompletableFuture<DeleteContactChannelResponse> |
deleteContactChannel(Consumer<DeleteContactChannelRequest.Builder> deleteContactChannelRequest)
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
|
default CompletableFuture<DeleteContactChannelResponse> |
deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest)
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
|
default CompletableFuture<DescribeEngagementResponse> |
describeEngagement(Consumer<DescribeEngagementRequest.Builder> describeEngagementRequest)
Incident Manager uses engagements to engage contacts and escalation plans during an incident.
|
default CompletableFuture<DescribeEngagementResponse> |
describeEngagement(DescribeEngagementRequest describeEngagementRequest)
Incident Manager uses engagements to engage contacts and escalation plans during an incident.
|
default CompletableFuture<DescribePageResponse> |
describePage(Consumer<DescribePageRequest.Builder> describePageRequest)
Lists details of the engagement to a contact channel.
|
default CompletableFuture<DescribePageResponse> |
describePage(DescribePageRequest describePageRequest)
Lists details of the engagement to a contact channel.
|
default CompletableFuture<GetContactResponse> |
getContact(Consumer<GetContactRequest.Builder> getContactRequest)
Retrieves information about the specified contact or escalation plan.
|
default CompletableFuture<GetContactResponse> |
getContact(GetContactRequest getContactRequest)
Retrieves information about the specified contact or escalation plan.
|
default CompletableFuture<GetContactChannelResponse> |
getContactChannel(Consumer<GetContactChannelRequest.Builder> getContactChannelRequest)
List details about a specific contact channel.
|
default CompletableFuture<GetContactChannelResponse> |
getContactChannel(GetContactChannelRequest getContactChannelRequest)
List details about a specific contact channel.
|
default CompletableFuture<GetContactPolicyResponse> |
getContactPolicy(Consumer<GetContactPolicyRequest.Builder> getContactPolicyRequest)
Retrieves the resource policies attached to the specified contact or escalation plan.
|
default CompletableFuture<GetContactPolicyResponse> |
getContactPolicy(GetContactPolicyRequest getContactPolicyRequest)
Retrieves the resource policies attached to the specified contact or escalation plan.
|
default CompletableFuture<ListContactChannelsResponse> |
listContactChannels(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default CompletableFuture<ListContactChannelsResponse> |
listContactChannels(ListContactChannelsRequest listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default ListContactChannelsPublisher |
listContactChannelsPaginator(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default ListContactChannelsPublisher |
listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest)
Lists all contact channels for the specified contact.
|
default CompletableFuture<ListContactsResponse> |
listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default CompletableFuture<ListContactsResponse> |
listContacts(ListContactsRequest listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default ListContactsPublisher |
listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default ListContactsPublisher |
listContactsPaginator(ListContactsRequest listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
|
default CompletableFuture<ListEngagementsResponse> |
listEngagements(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default CompletableFuture<ListEngagementsResponse> |
listEngagements(ListEngagementsRequest listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default ListEngagementsPublisher |
listEngagementsPaginator(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default ListEngagementsPublisher |
listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest)
Lists all engagements that have happened in an incident.
|
default CompletableFuture<ListPageReceiptsResponse> |
listPageReceipts(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default CompletableFuture<ListPageReceiptsResponse> |
listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default ListPageReceiptsPublisher |
listPageReceiptsPaginator(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default ListPageReceiptsPublisher |
listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
|
default CompletableFuture<ListPagesByContactResponse> |
listPagesByContact(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default CompletableFuture<ListPagesByContactResponse> |
listPagesByContact(ListPagesByContactRequest listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default ListPagesByContactPublisher |
listPagesByContactPaginator(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default ListPagesByContactPublisher |
listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
|
default CompletableFuture<ListPagesByEngagementResponse> |
listPagesByEngagement(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default CompletableFuture<ListPagesByEngagementResponse> |
listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default ListPagesByEngagementPublisher |
listPagesByEngagementPaginator(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default ListPagesByEngagementPublisher |
listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags of an escalation plan or contact.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags of an escalation plan or contact.
|
default CompletableFuture<PutContactPolicyResponse> |
putContactPolicy(Consumer<PutContactPolicyRequest.Builder> putContactPolicyRequest)
Adds a resource policy to the specified contact or escalation plan.
|
default CompletableFuture<PutContactPolicyResponse> |
putContactPolicy(PutContactPolicyRequest putContactPolicyRequest)
Adds a resource policy to the specified contact or escalation plan.
|
default CompletableFuture<SendActivationCodeResponse> |
sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest)
Sends an activation code to a contact channel.
|
default CompletableFuture<SendActivationCodeResponse> |
sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest)
Sends an activation code to a contact channel.
|
default CompletableFuture<StartEngagementResponse> |
startEngagement(Consumer<StartEngagementRequest.Builder> startEngagementRequest)
Starts an engagement to a contact or escalation plan.
|
default CompletableFuture<StartEngagementResponse> |
startEngagement(StartEngagementRequest startEngagementRequest)
Starts an engagement to a contact or escalation plan.
|
default CompletableFuture<StopEngagementResponse> |
stopEngagement(Consumer<StopEngagementRequest.Builder> stopEngagementRequest)
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
|
default CompletableFuture<StopEngagementResponse> |
stopEngagement(StopEngagementRequest stopEngagementRequest)
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags a contact or escalation plan.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Tags a contact or escalation plan.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified resource.
|
default CompletableFuture<UpdateContactResponse> |
updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest)
Updates the contact or escalation plan specified.
|
default CompletableFuture<UpdateContactResponse> |
updateContact(UpdateContactRequest updateContactRequest)
Updates the contact or escalation plan specified.
|
default CompletableFuture<UpdateContactChannelResponse> |
updateContactChannel(Consumer<UpdateContactChannelRequest.Builder> updateContactChannelRequest)
Updates a contact's contact channel.
|
default CompletableFuture<UpdateContactChannelResponse> |
updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest)
Updates a contact's contact channel.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static SsmContactsAsyncClient create()
SsmContactsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SsmContactsAsyncClientBuilder builder()
SsmContactsAsyncClient.default CompletableFuture<AcceptPageResponse> acceptPage(AcceptPageRequest acceptPageRequest)
Used to acknowledge an engagement to a contact channel during an incident.
acceptPageRequest - default CompletableFuture<AcceptPageResponse> acceptPage(Consumer<AcceptPageRequest.Builder> acceptPageRequest)
Used to acknowledge an engagement to a contact channel during an incident.
This is a convenience which creates an instance of the AcceptPageRequest.Builder avoiding the need to
create one manually via AcceptPageRequest.builder()
acceptPageRequest - A Consumer that will call methods on AcceptPageRequest.Builder to create a request.default CompletableFuture<ActivateContactChannelResponse> activateContactChannel(ActivateContactChannelRequest activateContactChannelRequest)
Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.
activateContactChannelRequest - default CompletableFuture<ActivateContactChannelResponse> activateContactChannel(Consumer<ActivateContactChannelRequest.Builder> activateContactChannelRequest)
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.Builder avoiding the
need to create one manually via ActivateContactChannelRequest.builder()
activateContactChannelRequest - A Consumer that will call methods on ActivateContactChannelRequest.Builder to create a
request.default CompletableFuture<CreateContactResponse> createContact(CreateContactRequest createContactRequest)
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.
createContactRequest - default CompletableFuture<CreateContactResponse> createContact(Consumer<CreateContactRequest.Builder> createContactRequest)
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.Builder avoiding the need to
create one manually via CreateContactRequest.builder()
createContactRequest - A Consumer that will call methods on CreateContactRequest.Builder to create a request.default CompletableFuture<CreateContactChannelResponse> createContactChannel(CreateContactChannelRequest createContactChannelRequest)
A contact channel is the method that Incident Manager uses to engage your contact.
createContactChannelRequest - default CompletableFuture<CreateContactChannelResponse> createContactChannel(Consumer<CreateContactChannelRequest.Builder> createContactChannelRequest)
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.Builder avoiding the
need to create one manually via CreateContactChannelRequest.builder()
createContactChannelRequest - A Consumer that will call methods on CreateContactChannelRequest.Builder to create a
request.default CompletableFuture<DeactivateContactChannelResponse> deactivateContactChannel(DeactivateContactChannelRequest deactivateContactChannelRequest)
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
deactivateContactChannelRequest - default CompletableFuture<DeactivateContactChannelResponse> deactivateContactChannel(Consumer<DeactivateContactChannelRequest.Builder> deactivateContactChannelRequest)
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.Builder avoiding
the need to create one manually via DeactivateContactChannelRequest.builder()
deactivateContactChannelRequest - A Consumer that will call methods on DeactivateContactChannelRequest.Builder to create a
request.default CompletableFuture<DeleteContactResponse> deleteContact(DeleteContactRequest deleteContactRequest)
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.
deleteContactRequest - default CompletableFuture<DeleteContactResponse> deleteContact(Consumer<DeleteContactRequest.Builder> deleteContactRequest)
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.Builder avoiding the need to
create one manually via DeleteContactRequest.builder()
deleteContactRequest - A Consumer that will call methods on DeleteContactRequest.Builder to create a request.default CompletableFuture<DeleteContactChannelResponse> deleteContactChannel(DeleteContactChannelRequest deleteContactChannelRequest)
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.
deleteContactChannelRequest - default CompletableFuture<DeleteContactChannelResponse> deleteContactChannel(Consumer<DeleteContactChannelRequest.Builder> deleteContactChannelRequest)
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.Builder avoiding the
need to create one manually via DeleteContactChannelRequest.builder()
deleteContactChannelRequest - A Consumer that will call methods on DeleteContactChannelRequest.Builder to create a
request.default CompletableFuture<DescribeEngagementResponse> describeEngagement(DescribeEngagementRequest describeEngagementRequest)
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.
describeEngagementRequest - default CompletableFuture<DescribeEngagementResponse> describeEngagement(Consumer<DescribeEngagementRequest.Builder> describeEngagementRequest)
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.Builder avoiding the
need to create one manually via DescribeEngagementRequest.builder()
describeEngagementRequest - A Consumer that will call methods on DescribeEngagementRequest.Builder to create a
request.default CompletableFuture<DescribePageResponse> describePage(DescribePageRequest describePageRequest)
Lists details of the engagement to a contact channel.
describePageRequest - default CompletableFuture<DescribePageResponse> describePage(Consumer<DescribePageRequest.Builder> describePageRequest)
Lists details of the engagement to a contact channel.
This is a convenience which creates an instance of the DescribePageRequest.Builder avoiding the need to
create one manually via DescribePageRequest.builder()
describePageRequest - A Consumer that will call methods on DescribePageRequest.Builder to create a request.default CompletableFuture<GetContactResponse> getContact(GetContactRequest getContactRequest)
Retrieves information about the specified contact or escalation plan.
getContactRequest - default CompletableFuture<GetContactResponse> getContact(Consumer<GetContactRequest.Builder> getContactRequest)
Retrieves information about the specified contact or escalation plan.
This is a convenience which creates an instance of the GetContactRequest.Builder avoiding the need to
create one manually via GetContactRequest.builder()
getContactRequest - A Consumer that will call methods on GetContactRequest.Builder to create a request.default CompletableFuture<GetContactChannelResponse> getContactChannel(GetContactChannelRequest getContactChannelRequest)
List details about a specific contact channel.
getContactChannelRequest - default CompletableFuture<GetContactChannelResponse> getContactChannel(Consumer<GetContactChannelRequest.Builder> getContactChannelRequest)
List details about a specific contact channel.
This is a convenience which creates an instance of the GetContactChannelRequest.Builder avoiding the need
to create one manually via GetContactChannelRequest.builder()
getContactChannelRequest - A Consumer that will call methods on GetContactChannelRequest.Builder to create a request.default CompletableFuture<GetContactPolicyResponse> getContactPolicy(GetContactPolicyRequest getContactPolicyRequest)
Retrieves the resource policies attached to the specified contact or escalation plan.
getContactPolicyRequest - default CompletableFuture<GetContactPolicyResponse> getContactPolicy(Consumer<GetContactPolicyRequest.Builder> getContactPolicyRequest)
Retrieves the resource policies attached to the specified contact or escalation plan.
This is a convenience which creates an instance of the GetContactPolicyRequest.Builder avoiding the need
to create one manually via GetContactPolicyRequest.builder()
getContactPolicyRequest - A Consumer that will call methods on GetContactPolicyRequest.Builder to create a request.default CompletableFuture<ListContactChannelsResponse> listContactChannels(ListContactChannelsRequest listContactChannelsRequest)
Lists all contact channels for the specified contact.
listContactChannelsRequest - default CompletableFuture<ListContactChannelsResponse> listContactChannels(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)
Lists all contact channels for the specified contact.
This is a convenience which creates an instance of the ListContactChannelsRequest.Builder avoiding the
need to create one manually via ListContactChannelsRequest.builder()
listContactChannelsRequest - A Consumer that will call methods on ListContactChannelsRequest.Builder to create a
request.default ListContactChannelsPublisher listContactChannelsPaginator(ListContactChannelsRequest listContactChannelsRequest)
Lists all contact channels for the specified contact.
This is a variant of
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listContactChannelsRequest - default ListContactChannelsPublisher listContactChannelsPaginator(Consumer<ListContactChannelsRequest.Builder> listContactChannelsRequest)
Lists all contact channels for the specified contact.
This is a variant of
listContactChannels(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactChannelsPublisher publisher = client.listContactChannelsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactChannelsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.Builder avoiding the
need to create one manually via ListContactChannelsRequest.builder()
listContactChannelsRequest - A Consumer that will call methods on ListContactChannelsRequest.Builder to create a
request.default CompletableFuture<ListContactsResponse> listContacts(ListContactsRequest listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
listContactsRequest - default CompletableFuture<ListContactsResponse> listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
This is a convenience which creates an instance of the ListContactsRequest.Builder avoiding the need to
create one manually via ListContactsRequest.builder()
listContactsRequest - A Consumer that will call methods on ListContactsRequest.Builder to create a request.default ListContactsPublisher listContactsPaginator(ListContactsRequest listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listContactsRequest - default ListContactsPublisher listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest)
Lists all contacts and escalation plans in Incident Manager.
This is a variant of listContacts(software.amazon.awssdk.services.ssmcontacts.model.ListContactsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListContactsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.Builder avoiding the need to
create one manually via ListContactsRequest.builder()
listContactsRequest - A Consumer that will call methods on ListContactsRequest.Builder to create a request.default CompletableFuture<ListEngagementsResponse> listEngagements(ListEngagementsRequest listEngagementsRequest)
Lists all engagements that have happened in an incident.
listEngagementsRequest - default CompletableFuture<ListEngagementsResponse> listEngagements(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)
Lists all engagements that have happened in an incident.
This is a convenience which creates an instance of the ListEngagementsRequest.Builder avoiding the need
to create one manually via ListEngagementsRequest.builder()
listEngagementsRequest - A Consumer that will call methods on ListEngagementsRequest.Builder to create a request.default ListEngagementsPublisher listEngagementsPaginator(ListEngagementsRequest listEngagementsRequest)
Lists all engagements that have happened in an incident.
This is a variant of
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listEngagementsRequest - default ListEngagementsPublisher listEngagementsPaginator(Consumer<ListEngagementsRequest.Builder> listEngagementsRequest)
Lists all engagements that have happened in an incident.
This is a variant of
listEngagements(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListEngagementsPublisher publisher = client.listEngagementsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListEngagementsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.Builder avoiding the need
to create one manually via ListEngagementsRequest.builder()
listEngagementsRequest - A Consumer that will call methods on ListEngagementsRequest.Builder to create a request.default CompletableFuture<ListPageReceiptsResponse> listPageReceipts(ListPageReceiptsRequest listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
listPageReceiptsRequest - default CompletableFuture<ListPageReceiptsResponse> listPageReceipts(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
This is a convenience which creates an instance of the ListPageReceiptsRequest.Builder avoiding the need
to create one manually via ListPageReceiptsRequest.builder()
listPageReceiptsRequest - A Consumer that will call methods on ListPageReceiptsRequest.Builder to create a request.default ListPageReceiptsPublisher listPageReceiptsPaginator(ListPageReceiptsRequest listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
This is a variant of
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listPageReceiptsRequest - default ListPageReceiptsPublisher listPageReceiptsPaginator(Consumer<ListPageReceiptsRequest.Builder> listPageReceiptsRequest)
Lists all of the engagements to contact channels that have been acknowledged.
This is a variant of
listPageReceipts(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListPageReceiptsPublisher publisher = client.listPageReceiptsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPageReceiptsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.Builder avoiding the need
to create one manually via ListPageReceiptsRequest.builder()
listPageReceiptsRequest - A Consumer that will call methods on ListPageReceiptsRequest.Builder to create a request.default CompletableFuture<ListPagesByContactResponse> listPagesByContact(ListPagesByContactRequest listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
listPagesByContactRequest - default CompletableFuture<ListPagesByContactResponse> listPagesByContact(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
This is a convenience which creates an instance of the ListPagesByContactRequest.Builder avoiding the
need to create one manually via ListPagesByContactRequest.builder()
listPagesByContactRequest - A Consumer that will call methods on ListPagesByContactRequest.Builder to create a
request.default ListPagesByContactPublisher listPagesByContactPaginator(ListPagesByContactRequest listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
This is a variant of
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listPagesByContactRequest - default ListPagesByContactPublisher listPagesByContactPaginator(Consumer<ListPagesByContactRequest.Builder> listPagesByContactRequest)
Lists the engagements to a contact's contact channels.
This is a variant of
listPagesByContact(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByContactPublisher publisher = client.listPagesByContactPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByContactResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.Builder avoiding the
need to create one manually via ListPagesByContactRequest.builder()
listPagesByContactRequest - A Consumer that will call methods on ListPagesByContactRequest.Builder to create a
request.default CompletableFuture<ListPagesByEngagementResponse> listPagesByEngagement(ListPagesByEngagementRequest listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
listPagesByEngagementRequest - default CompletableFuture<ListPagesByEngagementResponse> listPagesByEngagement(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
This is a convenience which creates an instance of the ListPagesByEngagementRequest.Builder avoiding the
need to create one manually via ListPagesByEngagementRequest.builder()
listPagesByEngagementRequest - A Consumer that will call methods on ListPagesByEngagementRequest.Builder to create a
request.default ListPagesByEngagementPublisher listPagesByEngagementPaginator(ListPagesByEngagementRequest listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
This is a variant of
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listPagesByEngagementRequest - default ListPagesByEngagementPublisher listPagesByEngagementPaginator(Consumer<ListPagesByEngagementRequest.Builder> listPagesByEngagementRequest)
Lists the engagements to contact channels that occurred by engaging a contact.
This is a variant of
listPagesByEngagement(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.ssmcontacts.paginators.ListPagesByEngagementPublisher publisher = client.listPagesByEngagementPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.ssmcontacts.model.ListPagesByEngagementResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.Builder avoiding the
need to create one manually via ListPagesByEngagementRequest.builder()
listPagesByEngagementRequest - A Consumer that will call methods on ListPagesByEngagementRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags of an escalation plan or contact.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags of an escalation plan or contact.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PutContactPolicyResponse> putContactPolicy(PutContactPolicyRequest putContactPolicyRequest)
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.
putContactPolicyRequest - default CompletableFuture<PutContactPolicyResponse> putContactPolicy(Consumer<PutContactPolicyRequest.Builder> putContactPolicyRequest)
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.Builder avoiding the need
to create one manually via PutContactPolicyRequest.builder()
putContactPolicyRequest - A Consumer that will call methods on PutContactPolicyRequest.Builder to create a request.default CompletableFuture<SendActivationCodeResponse> sendActivationCode(SendActivationCodeRequest sendActivationCodeRequest)
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 ActivateChannel operation. Incident Manager can't engage a contact channel
until it has been activated.
sendActivationCodeRequest - default CompletableFuture<SendActivationCodeResponse> sendActivationCode(Consumer<SendActivationCodeRequest.Builder> sendActivationCodeRequest)
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 ActivateChannel operation. Incident Manager can't engage a contact channel
until it has been activated.
This is a convenience which creates an instance of the SendActivationCodeRequest.Builder avoiding the
need to create one manually via SendActivationCodeRequest.builder()
sendActivationCodeRequest - A Consumer that will call methods on SendActivationCodeRequest.Builder to create a
request.default CompletableFuture<StartEngagementResponse> startEngagement(StartEngagementRequest startEngagementRequest)
Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.
startEngagementRequest - default CompletableFuture<StartEngagementResponse> startEngagement(Consumer<StartEngagementRequest.Builder> startEngagementRequest)
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.Builder avoiding the need
to create one manually via StartEngagementRequest.builder()
startEngagementRequest - A Consumer that will call methods on StartEngagementRequest.Builder to create a request.default CompletableFuture<StopEngagementResponse> stopEngagement(StopEngagementRequest stopEngagementRequest)
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.
stopEngagementRequest - default CompletableFuture<StopEngagementResponse> stopEngagement(Consumer<StopEngagementRequest.Builder> stopEngagementRequest)
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.Builder avoiding the need to
create one manually via StopEngagementRequest.builder()
stopEngagementRequest - A Consumer that will call methods on StopEngagementRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateContactResponse> updateContact(UpdateContactRequest updateContactRequest)
Updates the contact or escalation plan specified.
updateContactRequest - default CompletableFuture<UpdateContactResponse> updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest)
Updates the contact or escalation plan specified.
This is a convenience which creates an instance of the UpdateContactRequest.Builder avoiding the need to
create one manually via UpdateContactRequest.builder()
updateContactRequest - A Consumer that will call methods on UpdateContactRequest.Builder to create a request.default CompletableFuture<UpdateContactChannelResponse> updateContactChannel(UpdateContactChannelRequest updateContactChannelRequest)
Updates a contact's contact channel.
updateContactChannelRequest - default CompletableFuture<UpdateContactChannelResponse> updateContactChannel(Consumer<UpdateContactChannelRequest.Builder> updateContactChannelRequest)
Updates a contact's contact channel.
This is a convenience which creates an instance of the UpdateContactChannelRequest.Builder avoiding the
need to create one manually via UpdateContactChannelRequest.builder()
updateContactChannelRequest - A Consumer that will call methods on UpdateContactChannelRequest.Builder to create a
request.Copyright © 2022. All rights reserved.