describeOpsItems method

Future<DescribeOpsItemsResponse> describeOpsItems({ int? maxResults, String? nextToken, List<OpsItemFilter>? opsItemFilters, })

Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

May throw InternalServerError.

Parameter maxResults : The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameter nextToken : A token to start the list. Use this token to get the next set of results.

Parameter opsItemFilters : 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: 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

*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"}

Implementation

Future<DescribeOpsItemsResponse> describeOpsItems({
  int? maxResults,
  String? nextToken,
  List<OpsItemFilter>? opsItemFilters,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.DescribeOpsItems'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (opsItemFilters != null) 'OpsItemFilters': opsItemFilters,
    },
  );

  return DescribeOpsItemsResponse.fromJson(jsonResponse.body);
}