Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSM.DescribeOpsItems

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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

This operation returns paginated results.

Synopsis

data DescribeOpsItems = DescribeOpsItems' {
- opsItemFilters :: Maybe [OpsItemFilter]
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
newDescribeOpsItems :: DescribeOpsItems
describeOpsItems_opsItemFilters :: Lens' DescribeOpsItems (Maybe [OpsItemFilter])
describeOpsItems_nextToken :: Lens' DescribeOpsItems (Maybe Text)
describeOpsItems_maxResults :: Lens' DescribeOpsItems (Maybe Natural)
data DescribeOpsItemsResponse = DescribeOpsItemsResponse' {
- nextToken :: Maybe Text
- opsItemSummaries :: Maybe [OpsItemSummary]
- httpStatus :: Int
}
newDescribeOpsItemsResponse :: Int -> DescribeOpsItemsResponse
describeOpsItemsResponse_nextToken :: Lens' DescribeOpsItemsResponse (Maybe Text)
describeOpsItemsResponse_opsItemSummaries :: Lens' DescribeOpsItemsResponse (Maybe [OpsItemSummary])
describeOpsItemsResponse_httpStatus :: Lens' DescribeOpsItemsResponse Int

Creating a Request

data DescribeOpsItems Source #

See: newDescribeOpsItems smart constructor.

Constructors

DescribeOpsItems'

Fields

opsItemFilters :: Maybe [OpsItemFilter]
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
- 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"}
nextToken :: Maybe Text
A token to start the list. Use this token to get the next set of results.
maxResults :: Maybe Natural
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.

Instances

Instances details

Eq DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods (==) :: DescribeOpsItems -> DescribeOpsItems -> Bool # (/=) :: DescribeOpsItems -> DescribeOpsItems -> Bool #
Read DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods readsPrec :: Int -> ReadS DescribeOpsItems # readList :: ReadS [DescribeOpsItems] # readPrec :: ReadPrec DescribeOpsItems # readListPrec :: ReadPrec [DescribeOpsItems] #
Show DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods showsPrec :: Int -> DescribeOpsItems -> ShowS # show :: DescribeOpsItems -> String # showList :: [DescribeOpsItems] -> ShowS #
Generic DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Associated Types type Rep DescribeOpsItems :: Type -> Type # Methods from :: DescribeOpsItems -> Rep DescribeOpsItems x # to :: Rep DescribeOpsItems x -> DescribeOpsItems #
NFData DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods rnf :: DescribeOpsItems -> () #
Hashable DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods hashWithSalt :: Int -> DescribeOpsItems -> Int # hash :: DescribeOpsItems -> Int #
ToJSON DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods toJSON :: DescribeOpsItems -> Value # toEncoding :: DescribeOpsItems -> Encoding # toJSONList :: [DescribeOpsItems] -> Value # toEncodingList :: [DescribeOpsItems] -> Encoding #
AWSPager DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods page :: DescribeOpsItems -> AWSResponse DescribeOpsItems -> Maybe DescribeOpsItems #
AWSRequest DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Associated Types type AWSResponse DescribeOpsItems # Methods request :: DescribeOpsItems -> Request DescribeOpsItems # response :: MonadResource m => Logger -> Service -> Proxy DescribeOpsItems -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeOpsItems))) #
ToHeaders DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods toHeaders :: DescribeOpsItems -> [Header] #
ToPath DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods toPath :: DescribeOpsItems -> ByteString #
ToQuery DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods toQuery :: DescribeOpsItems -> QueryString #
type Rep DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems type Rep DescribeOpsItems = D1 ('MetaData "DescribeOpsItems" "Amazonka.SSM.DescribeOpsItems" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeOpsItems'" 'PrefixI 'True) (S1 ('MetaSel ('Just "opsItemFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OpsItemFilter])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeOpsItems Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems type AWSResponse DescribeOpsItems = DescribeOpsItemsResponse

newDescribeOpsItems :: DescribeOpsItems Source #

Create a value of DescribeOpsItems with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:opsItemFilters:DescribeOpsItems', describeOpsItems_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: 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
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"}

$sel:nextToken:DescribeOpsItems', describeOpsItems_nextToken - A token to start the list. Use this token to get the next set of results.

$sel:maxResults:DescribeOpsItems', describeOpsItems_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.

Request Lenses

describeOpsItems_opsItemFilters :: Lens' DescribeOpsItems (Maybe [OpsItemFilter]) Source #

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

describeOpsItems_nextToken :: Lens' DescribeOpsItems (Maybe Text) Source #

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

describeOpsItems_maxResults :: Lens' DescribeOpsItems (Maybe Natural) Source #

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.

Destructuring the Response

data DescribeOpsItemsResponse Source #

See: newDescribeOpsItemsResponse smart constructor.

Constructors

DescribeOpsItemsResponse'
Fields nextToken :: Maybe Text The token for the next set of items to return. Use this token to get the next set of results. opsItemSummaries :: Maybe [OpsItemSummary] A list of OpsItems. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeOpsItemsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods (==) :: DescribeOpsItemsResponse -> DescribeOpsItemsResponse -> Bool # (/=) :: DescribeOpsItemsResponse -> DescribeOpsItemsResponse -> Bool #
Read DescribeOpsItemsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods readsPrec :: Int -> ReadS DescribeOpsItemsResponse # readList :: ReadS [DescribeOpsItemsResponse] # readPrec :: ReadPrec DescribeOpsItemsResponse # readListPrec :: ReadPrec [DescribeOpsItemsResponse] #
Show DescribeOpsItemsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods showsPrec :: Int -> DescribeOpsItemsResponse -> ShowS # show :: DescribeOpsItemsResponse -> String # showList :: [DescribeOpsItemsResponse] -> ShowS #
Generic DescribeOpsItemsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Associated Types type Rep DescribeOpsItemsResponse :: Type -> Type # Methods from :: DescribeOpsItemsResponse -> Rep DescribeOpsItemsResponse x # to :: Rep DescribeOpsItemsResponse x -> DescribeOpsItemsResponse #
NFData DescribeOpsItemsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems Methods rnf :: DescribeOpsItemsResponse -> () #
type Rep DescribeOpsItemsResponse Source #
Instance details Defined in Amazonka.SSM.DescribeOpsItems type Rep DescribeOpsItemsResponse = D1 ('MetaData "DescribeOpsItemsResponse" "Amazonka.SSM.DescribeOpsItems" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeOpsItemsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "opsItemSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OpsItemSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeOpsItemsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeOpsItemsResponse'`
-> DescribeOpsItemsResponse

Create a value of DescribeOpsItemsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:DescribeOpsItems', describeOpsItemsResponse_nextToken - The token for the next set of items to return. Use this token to get the next set of results.

$sel:opsItemSummaries:DescribeOpsItemsResponse', describeOpsItemsResponse_opsItemSummaries - A list of OpsItems.

$sel:httpStatus:DescribeOpsItemsResponse', describeOpsItemsResponse_httpStatus - The response's http status code.

Response Lenses

describeOpsItemsResponse_nextToken :: Lens' DescribeOpsItemsResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

describeOpsItemsResponse_opsItemSummaries :: Lens' DescribeOpsItemsResponse (Maybe [OpsItemSummary]) Source #

A list of OpsItems.

describeOpsItemsResponse_httpStatus :: Lens' DescribeOpsItemsResponse Int Source #

The response's http status code.