public static interface UpdateOpsItemRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<UpdateOpsItemRequest.Builder,UpdateOpsItemRequest>
Modifier and Type | Method and Description |
---|---|
UpdateOpsItemRequest.Builder |
actualEndTime(Instant actualEndTime)
The time a runbook workflow ended.
|
UpdateOpsItemRequest.Builder |
actualStartTime(Instant actualStartTime)
The time a runbook workflow started.
|
UpdateOpsItemRequest.Builder |
category(String category)
Specify a new category for an OpsItem.
|
UpdateOpsItemRequest.Builder |
description(String description)
Update the information about the OpsItem.
|
UpdateOpsItemRequest.Builder |
notifications(Collection<OpsItemNotification> notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.
|
UpdateOpsItemRequest.Builder |
notifications(Consumer<OpsItemNotification.Builder>... notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.
|
UpdateOpsItemRequest.Builder |
notifications(OpsItemNotification... notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
changed.
|
UpdateOpsItemRequest.Builder |
operationalData(Map<String,OpsItemDataValue> operationalData)
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
|
UpdateOpsItemRequest.Builder |
operationalDataToDelete(Collection<String> operationalDataToDelete)
Keys that you want to remove from the OperationalData map.
|
UpdateOpsItemRequest.Builder |
operationalDataToDelete(String... operationalDataToDelete)
Keys that you want to remove from the OperationalData map.
|
UpdateOpsItemRequest.Builder |
opsItemId(String opsItemId)
The ID of the OpsItem.
|
UpdateOpsItemRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
UpdateOpsItemRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
UpdateOpsItemRequest.Builder |
plannedEndTime(Instant plannedEndTime)
The time specified in a change request for a runbook workflow to end.
|
UpdateOpsItemRequest.Builder |
plannedStartTime(Instant plannedStartTime)
The time specified in a change request for a runbook workflow to start.
|
UpdateOpsItemRequest.Builder |
priority(Integer priority)
The importance of this OpsItem in relation to other OpsItems in the system.
|
UpdateOpsItemRequest.Builder |
relatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.
|
UpdateOpsItemRequest.Builder |
relatedOpsItems(Consumer<RelatedOpsItem.Builder>... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.
|
UpdateOpsItemRequest.Builder |
relatedOpsItems(RelatedOpsItem... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.
|
UpdateOpsItemRequest.Builder |
severity(String severity)
Specify a new severity for an OpsItem.
|
UpdateOpsItemRequest.Builder |
status(OpsItemStatus status)
The OpsItem status.
|
UpdateOpsItemRequest.Builder |
status(String status)
The OpsItem status.
|
UpdateOpsItemRequest.Builder |
title(String title)
A short heading that describes the nature of the OpsItem and the impacted resource.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
UpdateOpsItemRequest.Builder description(String description)
Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
description
- Update the information about the OpsItem. Provide enough information so that users reading this
OpsItem for the first time understand the issue.UpdateOpsItemRequest.Builder operationalData(Map<String,OpsItemDataValue> operationalData)
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
Use the /aws/resources
key in OperationalData to specify a related resource in the request. Use
the /aws/automations
key in OperationalData to associate an Automation runbook with the OpsItem.
To view AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
operationalData
- Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).
Use the /aws/resources
key in OperationalData to specify a related resource in the
request. Use the /aws/automations
key in OperationalData to associate an Automation
runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems manually in the AWS Systems Manager User Guide.
UpdateOpsItemRequest.Builder operationalDataToDelete(Collection<String> operationalDataToDelete)
Keys that you want to remove from the OperationalData map.
operationalDataToDelete
- Keys that you want to remove from the OperationalData map.UpdateOpsItemRequest.Builder operationalDataToDelete(String... operationalDataToDelete)
Keys that you want to remove from the OperationalData map.
operationalDataToDelete
- Keys that you want to remove from the OperationalData map.UpdateOpsItemRequest.Builder notifications(Collection<OpsItemNotification> notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
notifications
- The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is
edited or changed.UpdateOpsItemRequest.Builder notifications(OpsItemNotification... notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
notifications
- The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is
edited or changed.UpdateOpsItemRequest.Builder notifications(Consumer<OpsItemNotification.Builder>... notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
This is a convenience that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #notifications(List)
.notifications
- a consumer that will call methods on List.Builder
#notifications(List)
UpdateOpsItemRequest.Builder priority(Integer priority)
The importance of this OpsItem in relation to other OpsItems in the system.
priority
- The importance of this OpsItem in relation to other OpsItems in the system.UpdateOpsItemRequest.Builder relatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
relatedOpsItems
- One or more OpsItems that share something in common with the current OpsItems. For example, related
OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the
impacted resource.UpdateOpsItemRequest.Builder relatedOpsItems(RelatedOpsItem... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
relatedOpsItems
- One or more OpsItems that share something in common with the current OpsItems. For example, related
OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the
impacted resource.UpdateOpsItemRequest.Builder relatedOpsItems(Consumer<RelatedOpsItem.Builder>... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #relatedOpsItems(List)
.relatedOpsItems
- a consumer that will call methods on List.Builder
#relatedOpsItems(List)
UpdateOpsItemRequest.Builder status(String status)
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For
more information, see Editing OpsItem details in the AWS Systems Manager User Guide.
status
- The OpsItem status. Status can be Open
, In Progress
, or
Resolved
. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.OpsItemStatus
,
OpsItemStatus
UpdateOpsItemRequest.Builder status(OpsItemStatus status)
The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For
more information, see Editing OpsItem details in the AWS Systems Manager User Guide.
status
- The OpsItem status. Status can be Open
, In Progress
, or
Resolved
. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.OpsItemStatus
,
OpsItemStatus
UpdateOpsItemRequest.Builder opsItemId(String opsItemId)
The ID of the OpsItem.
opsItemId
- The ID of the OpsItem.UpdateOpsItemRequest.Builder title(String title)
A short heading that describes the nature of the OpsItem and the impacted resource.
title
- A short heading that describes the nature of the OpsItem and the impacted resource.UpdateOpsItemRequest.Builder category(String category)
Specify a new category for an OpsItem.
category
- Specify a new category for an OpsItem.UpdateOpsItemRequest.Builder severity(String severity)
Specify a new severity for an OpsItem.
severity
- Specify a new severity for an OpsItem.UpdateOpsItemRequest.Builder actualStartTime(Instant actualStartTime)
The time a runbook workflow started. Currently reported only for the OpsItem type
/aws/changerequest
.
actualStartTime
- The time a runbook workflow started. Currently reported only for the OpsItem type
/aws/changerequest
.UpdateOpsItemRequest.Builder actualEndTime(Instant actualEndTime)
The time a runbook workflow ended. Currently reported only for the OpsItem type
/aws/changerequest
.
actualEndTime
- The time a runbook workflow ended. Currently reported only for the OpsItem type
/aws/changerequest
.UpdateOpsItemRequest.Builder plannedStartTime(Instant plannedStartTime)
The time specified in a change request for a runbook workflow to start. Currently supported only for the
OpsItem type /aws/changerequest
.
plannedStartTime
- The time specified in a change request for a runbook workflow to start. Currently supported only for
the OpsItem type /aws/changerequest
.UpdateOpsItemRequest.Builder plannedEndTime(Instant plannedEndTime)
The time specified in a change request for a runbook workflow to end. Currently supported only for the
OpsItem type /aws/changerequest
.
plannedEndTime
- The time specified in a change request for a runbook workflow to end. Currently supported only for the
OpsItem type /aws/changerequest
.UpdateOpsItemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.UpdateOpsItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.