Interface UpdateOpsItemRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateOpsItemRequest.Builder,UpdateOpsItemRequest>, SdkBuilder<UpdateOpsItemRequest.Builder,UpdateOpsItemRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder
Enclosing class:
UpdateOpsItemRequest
@Mutable @NotThreadSafe public static interface UpdateOpsItemRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<UpdateOpsItemRequest.Builder,UpdateOpsItemRequest>

  • Method Details

    • description

      UpdateOpsItemRequest.Builder description(String description)

      User-defined text that contains information about the OpsItem, in Markdown format.

      Parameters:
      description - User-defined text that contains information about the OpsItem, in Markdown format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationalData

      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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

      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 Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

      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 Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationalDataToDelete

      UpdateOpsItemRequest.Builder operationalDataToDelete(Collection<String> operationalDataToDelete)

      Keys that you want to remove from the OperationalData map.

      Parameters:
      operationalDataToDelete - Keys that you want to remove from the OperationalData map.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operationalDataToDelete

      UpdateOpsItemRequest.Builder operationalDataToDelete(String... operationalDataToDelete)

      Keys that you want to remove from the OperationalData map.

      Parameters:
      operationalDataToDelete - Keys that you want to remove from the OperationalData map.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notifications

      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.

      Parameters:
      notifications - The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notifications

      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.

      Parameters:
      notifications - The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notifications

      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 method that creates an instance of the OpsItemNotification.Builder avoiding the need to create one manually via OpsItemNotification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notifications(List<OpsItemNotification>).

      Parameters:
      notifications - a consumer that will call methods on OpsItemNotification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • priority

      UpdateOpsItemRequest.Builder priority(Integer priority)

      The importance of this OpsItem in relation to other OpsItems in the system.

      Parameters:
      priority - The importance of this OpsItem in relation to other OpsItems in the system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedOpsItems

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedOpsItems

      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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedOpsItems

      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 method that creates an instance of the RelatedOpsItem.Builder avoiding the need to create one manually via RelatedOpsItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to relatedOpsItems(List<RelatedOpsItem>).

      Parameters:
      relatedOpsItems - a consumer that will call methods on RelatedOpsItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      UpdateOpsItemRequest.Builder status(String status)

      The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      status - The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      UpdateOpsItemRequest.Builder status(OpsItemStatus status)

      The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.

      Parameters:
      status - The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • opsItemId

      UpdateOpsItemRequest.Builder opsItemId(String opsItemId)

      The ID of the OpsItem.

      Parameters:
      opsItemId - The ID of the OpsItem.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      UpdateOpsItemRequest.Builder title(String title)

      A short heading that describes the nature of the OpsItem and the impacted resource.

      Parameters:
      title - A short heading that describes the nature of the OpsItem and the impacted resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • category

      UpdateOpsItemRequest.Builder category(String category)

      Specify a new category for an OpsItem.

      Parameters:
      category - Specify a new category for an OpsItem.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • severity

      UpdateOpsItemRequest.Builder severity(String severity)

      Specify a new severity for an OpsItem.

      Parameters:
      severity - Specify a new severity for an OpsItem.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actualStartTime

      UpdateOpsItemRequest.Builder actualStartTime(Instant actualStartTime)

      The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

      Parameters:
      actualStartTime - The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actualEndTime

      UpdateOpsItemRequest.Builder actualEndTime(Instant actualEndTime)

      The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

      Parameters:
      actualEndTime - The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • plannedStartTime

      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.

      Parameters:
      plannedStartTime - The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • plannedEndTime

      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.

      Parameters:
      plannedEndTime - The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • opsItemArn

      UpdateOpsItemRequest.Builder opsItemArn(String opsItemArn)

      The OpsItem Amazon Resource Name (ARN).

      Parameters:
      opsItemArn - The OpsItem Amazon Resource Name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateOpsItemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateOpsItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.