SSM / Paginator / DescribeOpsItems

DescribeOpsItems

class SSM.Paginator.DescribeOpsItems

paginator = client.get_paginator('describe_ops_items')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSM.Client.describe_ops_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OpsItemFilters=[
        {
            'Key': 'Status'|'CreatedBy'|'Source'|'Priority'|'Title'|'OpsItemId'|'CreatedTime'|'LastModifiedTime'|'ActualStartTime'|'ActualEndTime'|'PlannedStartTime'|'PlannedEndTime'|'OperationalData'|'OperationalDataKey'|'OperationalDataValue'|'ResourceId'|'AutomationId'|'Category'|'Severity'|'OpsItemType'|'ChangeRequestByRequesterArn'|'ChangeRequestByRequesterName'|'ChangeRequestByApproverArn'|'ChangeRequestByApproverName'|'ChangeRequestByTemplate'|'ChangeRequestByTargetsResourceGroup'|'InsightByType'|'AccountId',
            'Values': [
                'string',
            ],
            'Operator': 'Equal'|'Contains'|'GreaterThan'|'LessThan'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OpsItemFilters (list) –

  One or more filters to limit the response.

  • Key: CreatedTime Operations: GreaterThan, LessThan

  • Key: LastModifiedBy Operations: Contains, Equals

  • Key: LastModifiedTime Operations: GreaterThan, LessThan

  • Key: Priority Operations: Equals

  • Key: Source Operations: Contains, Equals

  • Key: Status Operations: Equals

  • Key: Title* Operations: Equals,Contains

  • Key: OperationalData** Operations: Equals

  • Key: OperationalDataKey Operations: Equals

  • Key: OperationalDataValue Operations: Equals, Contains

  • Key: OpsItemId Operations: Equals

  • Key: ResourceId Operations: Contains

  • Key: AutomationId Operations: Equals

  • Key: AccountId Operations: Equals

  *The Equals operator for Title matches the first 100 characters. If you specify more than 100 characters, they system returns an error that the filter value exceeds the length limit.

  **If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {“key”:”key_name”,”value”:”a_value”}

  • (dict) –

    Describes an OpsItem filter.

    • Key (string) – [REQUIRED]

      The name of the filter.

    • Values (list) – [REQUIRED]

      The filter value.

      • (string) –

    • Operator (string) – [REQUIRED]

      The operator used by the filter call.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'OpsItemSummaries': [
        {
            'CreatedBy': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LastModifiedBy': 'string',
            'LastModifiedTime': datetime(2015, 1, 1),
            'Priority': 123,
            'Source': 'string',
            'Status': 'Open'|'InProgress'|'Resolved'|'Pending'|'TimedOut'|'Cancelling'|'Cancelled'|'Failed'|'CompletedWithSuccess'|'CompletedWithFailure'|'Scheduled'|'RunbookInProgress'|'PendingChangeCalendarOverride'|'ChangeCalendarOverrideApproved'|'ChangeCalendarOverrideRejected'|'PendingApproval'|'Approved'|'Rejected'|'Closed',
            'OpsItemId': 'string',
            'Title': 'string',
            'OperationalData': {
                'string': {
                    'Value': 'string',
                    'Type': 'SearchableString'|'String'
                }
            },
            'Category': 'string',
            'Severity': 'string',
            'OpsItemType': 'string',
            'ActualStartTime': datetime(2015, 1, 1),
            'ActualEndTime': datetime(2015, 1, 1),
            'PlannedStartTime': datetime(2015, 1, 1),
            'PlannedEndTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • OpsItemSummaries (list) –

    A list of OpsItems.

    • (dict) –

      A count of OpsItems.

      • CreatedBy (string) –

        The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

      • CreatedTime (datetime) –

        The date and time the OpsItem was created.

      • LastModifiedBy (string) –

        The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

      • LastModifiedTime (datetime) –

        The date and time the OpsItem was last updated.

      • Priority (integer) –

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

      • Source (string) –

        The impacted Amazon Web Services resource.

      • Status (string) –

        The OpsItem status.

      • OpsItemId (string) –

        The ID of the OpsItem.

      • Title (string) –

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

      • OperationalData (dict) –

        Operational data is custom data that provides useful reference details about the OpsItem.

        • (string) –

          • (dict) –

            An object that defines the value of the key and its type in the OperationalData map.

            • Value (string) –

              The value of the OperationalData key.

            • Type (string) –

              The type of key-value pair. Valid types include SearchableString and String.

      • Category (string) –

        A list of OpsItems by category.

      • Severity (string) –

        A list of OpsItems by severity.

      • OpsItemType (string) –

        The type of OpsItem. Systems Manager supports the following types of OpsItems:

        • /aws/issue This type of OpsItem is used for default OpsItems created by OpsCenter.

        • /aws/changerequest This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

        • /aws/insight This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

      • ActualStartTime (datetime) –

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

      • ActualEndTime (datetime) –

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

      • PlannedStartTime (datetime) –

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

      • PlannedEndTime (datetime) –

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