NAME

Paws::SSM::UpdateOpsItem - Arguments for method UpdateOpsItem on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method UpdateOpsItem on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method UpdateOpsItem.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateOpsItem.

SYNOPSIS

    my $ssm = Paws->service('SSM');
    my $UpdateOpsItemResponse = $ssm->UpdateOpsItem(
      OpsItemId       => 'MyOpsItemId',
      ActualEndTime   => '1970-01-01T01:00:00',     # OPTIONAL
      ActualStartTime => '1970-01-01T01:00:00',     # OPTIONAL
      Category        => 'MyOpsItemCategory',       # OPTIONAL
      Description     => 'MyOpsItemDescription',    # OPTIONAL
      Notifications   => [
        {
          Arn => 'MyString',                        # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      OperationalData => {
        'MyOpsItemDataKey' => {
          Type =>
            'SearchableString',    # values: SearchableString, String; OPTIONAL
          Value => 'MyOpsItemDataValueString',    # OPTIONAL
        },    # key: min: 1, max: 128
      },    # OPTIONAL
      OperationalDataToDelete => [
        'MyString', ...    # OPTIONAL
      ],    # OPTIONAL
      PlannedEndTime   => '1970-01-01T01:00:00',    # OPTIONAL
      PlannedStartTime => '1970-01-01T01:00:00',    # OPTIONAL
      Priority         => 1,                        # OPTIONAL
      RelatedOpsItems  => [
        {
          OpsItemId => 'MyString',                  # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      Severity => 'MyOpsItemSeverity',    # OPTIONAL
      Status   => 'Open',                 # OPTIONAL
      Title    => 'MyOpsItemTitle',       # OPTIONAL
    );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ssm/UpdateOpsItem>

ATTRIBUTES

ActualEndTime => Str

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

ActualStartTime => Str

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

Category => Str

Specify a new category for an OpsItem.

Description => Str

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Notifications => ArrayRef[Paws::SSM::OpsItemNotification]

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

OperationalData => Paws::SSM::OpsItemOperationalData

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 (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-creating-OpsItems.html#OpsCenter-manually-create-OpsItems) in the AWS Systems Manager User Guide.

OperationalDataToDelete => ArrayRef[Str|Undef]

Keys that you want to remove from the OperationalData map.

REQUIRED OpsItemId => Str

The ID of the OpsItem.

PlannedEndTime => Str

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type "/aws/changerequest".

PlannedStartTime => Str

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type "/aws/changerequest".

Priority => Int

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

RelatedOpsItems => ArrayRef[Paws::SSM::RelatedOpsItem]

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.

Severity => Str

Specify a new severity for an OpsItem.

Status => Str

The OpsItem status. Status can be "Open", "In Progress", or "Resolved". For more information, see Editing OpsItem details (https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems.html#OpsCenter-working-with-OpsItems-editing-details) in the AWS Systems Manager User Guide.

Valid values are: "Open", "InProgress", "Resolved", "Pending", "TimedOut", "Cancelling", "Cancelled", "Failed", "CompletedWithSuccess", "CompletedWithFailure", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "PendingApproval", "Approved", "Rejected"

Title => Str

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>