software.amazon.awssdk.services.ssmincidents.model

Class UpdateResponsePlanRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssmincidents.model.SsmIncidentsRequest

software.amazon.awssdk.services.ssmincidents.model.UpdateResponsePlanRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateResponsePlanRequest.Builder,UpdateResponsePlanRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateResponsePlanRequest
extends SsmIncidentsRequest
implements ToCopyableBuilder<UpdateResponsePlanRequest.Builder,UpdateResponsePlanRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateResponsePlanRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<Action>	actions() The actions that this response plan takes at the beginning of an incident.
String	arn() The Amazon Resource Name (ARN) of the response plan.
static UpdateResponsePlanRequest.Builder	builder()
ChatChannel	chatChannel() The Chatbot chat channel used for collaboration during an incident.
String	clientToken() A token ensuring that the operation is called only once with the specified details.
String	displayName() The long format name of the response plan.
List<String>	engagements() The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasActions() For responses, this returns true if the service returned a value for the Actions property.
boolean	hasEngagements() For responses, this returns true if the service returned a value for the Engagements property.
int	hashCode()
boolean	hasIncidentTemplateNotificationTargets() For responses, this returns true if the service returned a value for the IncidentTemplateNotificationTargets property.
boolean	hasIncidentTemplateTags() For responses, this returns true if the service returned a value for the IncidentTemplateTags property.
boolean	hasIntegrations() For responses, this returns true if the service returned a value for the Integrations property.
String	incidentTemplateDedupeString() The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
Integer	incidentTemplateImpact() Defines the impact to the customers.
List<NotificationTargetItem>	incidentTemplateNotificationTargets() The Amazon SNS targets that are notified when updates are made to an incident.
String	incidentTemplateSummary() A brief summary of the incident.
Map<String,String>	incidentTemplateTags() Tags to assign to the template.
String	incidentTemplateTitle() The short format name of the incident.
List<Integration>	integrations() Information about third-party services integrated into the response plan.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateResponsePlanRequest.Builder>	serializableBuilderClass()
UpdateResponsePlanRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasActions

public final boolean hasActions()

For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

actions

public final List<Action> actions()

The actions that this response plan takes at the beginning of an incident.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

Returns:

The actions that this response plan takes at the beginning of an incident.

arn

public final String arn()

The Amazon Resource Name (ARN) of the response plan.

Returns:

The Amazon Resource Name (ARN) of the response plan.

chatChannel

public final ChatChannel chatChannel()

The Chatbot chat channel used for collaboration during an incident.

Use the empty structure to remove the chat channel from the response plan.

Returns:

The Chatbot chat channel used for collaboration during an incident.

Use the empty structure to remove the chat channel from the response plan.

clientToken

public final String clientToken()

A token ensuring that the operation is called only once with the specified details.

Returns:

A token ensuring that the operation is called only once with the specified details.

displayName

public final String displayName()

The long format name of the response plan. The display name can't contain spaces.

Returns:

The long format name of the response plan. The display name can't contain spaces.

hasEngagements

public final boolean hasEngagements()

For responses, this returns true if the service returned a value for the Engagements property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

engagements

public final List<String> engagements()

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEngagements() method.

Returns:

The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

incidentTemplateDedupeString

public final String incidentTemplateDedupeString()

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

Returns:

The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

incidentTemplateImpact

public final Integer incidentTemplateImpact()

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts:

• 5 - Severe impact

• 4 - High impact

• 3 - Medium impact

• 2 - Low impact

• 1 - No impact

Returns:

Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

Possible impacts:

• 5 - Severe impact

• 4 - High impact

• 3 - Medium impact

• 2 - Low impact

• 1 - No impact

hasIncidentTemplateNotificationTargets

public final boolean hasIncidentTemplateNotificationTargets()

For responses, this returns true if the service returned a value for the IncidentTemplateNotificationTargets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

incidentTemplateNotificationTargets

public final List<NotificationTargetItem> incidentTemplateNotificationTargets()

The Amazon SNS targets that are notified when updates are made to an incident.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncidentTemplateNotificationTargets() method.

Returns:

The Amazon SNS targets that are notified when updates are made to an incident.

incidentTemplateSummary

public final String incidentTemplateSummary()

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

Returns:

A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

hasIncidentTemplateTags

public final boolean hasIncidentTemplateTags()

For responses, this returns true if the service returned a value for the IncidentTemplateTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

incidentTemplateTags

public final Map<String,String> incidentTemplateTags()

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncidentTemplateTags() method.

Returns:

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

incidentTemplateTitle

public final String incidentTemplateTitle()

The short format name of the incident. The title can't contain spaces.

Returns:

The short format name of the incident. The title can't contain spaces.

hasIntegrations

public final boolean hasIntegrations()

For responses, this returns true if the service returned a value for the Integrations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

integrations

public final List<Integration> integrations()

Information about third-party services integrated into the response plan.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIntegrations() method.

Returns:

Information about third-party services integrated into the response plan.

toBuilder

public UpdateResponsePlanRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateResponsePlanRequest.Builder,UpdateResponsePlanRequest>

Specified by:

toBuilder in class SsmIncidentsRequest

builder

public static UpdateResponsePlanRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateResponsePlanRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo