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.GetOpsSummary

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

View a summary of operations metadata (OpsData) based on specified filters and aggregators. OpsData can include information about Amazon Web Services Systems Manager OpsCenter operational workitems (OpsItems) as well as information about any Amazon Web Services resource or service configured to report OpsData to Amazon Web Services Systems Manager Explorer.

This operation returns paginated results.

Synopsis

data GetOpsSummary = GetOpsSummary' {
- aggregators :: Maybe (NonEmpty OpsAggregator)
- syncName :: Maybe Text
- filters :: Maybe (NonEmpty OpsFilter)
- resultAttributes :: Maybe (NonEmpty OpsResultAttribute)
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
}
newGetOpsSummary :: GetOpsSummary
getOpsSummary_aggregators :: Lens' GetOpsSummary (Maybe (NonEmpty OpsAggregator))
getOpsSummary_syncName :: Lens' GetOpsSummary (Maybe Text)
getOpsSummary_filters :: Lens' GetOpsSummary (Maybe (NonEmpty OpsFilter))
getOpsSummary_resultAttributes :: Lens' GetOpsSummary (Maybe (NonEmpty OpsResultAttribute))
getOpsSummary_nextToken :: Lens' GetOpsSummary (Maybe Text)
getOpsSummary_maxResults :: Lens' GetOpsSummary (Maybe Natural)
data GetOpsSummaryResponse = GetOpsSummaryResponse' {
- entities :: Maybe [OpsEntity]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetOpsSummaryResponse :: Int -> GetOpsSummaryResponse
getOpsSummaryResponse_entities :: Lens' GetOpsSummaryResponse (Maybe [OpsEntity])
getOpsSummaryResponse_nextToken :: Lens' GetOpsSummaryResponse (Maybe Text)
getOpsSummaryResponse_httpStatus :: Lens' GetOpsSummaryResponse Int

Creating a Request

data GetOpsSummary Source #

See: newGetOpsSummary smart constructor.

Constructors

GetOpsSummary'

Fields

aggregators :: Maybe (NonEmpty OpsAggregator)
Optional aggregators that return counts of OpsData based on one or more expressions.
syncName :: Maybe Text
Specify the name of a resource data sync to get.
filters :: Maybe (NonEmpty OpsFilter)
Optional filters used to scope down the returned OpsData.
resultAttributes :: Maybe (NonEmpty OpsResultAttribute)
The OpsData data type to return.
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 GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods (==) :: GetOpsSummary -> GetOpsSummary -> Bool # (/=) :: GetOpsSummary -> GetOpsSummary -> Bool #
Read GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods readsPrec :: Int -> ReadS GetOpsSummary # readList :: ReadS [GetOpsSummary] # readPrec :: ReadPrec GetOpsSummary # readListPrec :: ReadPrec [GetOpsSummary] #
Show GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods showsPrec :: Int -> GetOpsSummary -> ShowS # show :: GetOpsSummary -> String # showList :: [GetOpsSummary] -> ShowS #
Generic GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Associated Types type Rep GetOpsSummary :: Type -> Type # Methods from :: GetOpsSummary -> Rep GetOpsSummary x # to :: Rep GetOpsSummary x -> GetOpsSummary #
NFData GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods rnf :: GetOpsSummary -> () #
Hashable GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods hashWithSalt :: Int -> GetOpsSummary -> Int # hash :: GetOpsSummary -> Int #
ToJSON GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods toJSON :: GetOpsSummary -> Value # toEncoding :: GetOpsSummary -> Encoding # toJSONList :: [GetOpsSummary] -> Value # toEncodingList :: [GetOpsSummary] -> Encoding #
AWSPager GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods page :: GetOpsSummary -> AWSResponse GetOpsSummary -> Maybe GetOpsSummary #
AWSRequest GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Associated Types type AWSResponse GetOpsSummary # Methods request :: GetOpsSummary -> Request GetOpsSummary # response :: MonadResource m => Logger -> Service -> Proxy GetOpsSummary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetOpsSummary))) #
ToHeaders GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods toHeaders :: GetOpsSummary -> [Header] #
ToPath GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods toPath :: GetOpsSummary -> ByteString #
ToQuery GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary Methods toQuery :: GetOpsSummary -> QueryString #
type Rep GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary type Rep GetOpsSummary = D1 ('MetaData "GetOpsSummary" "Amazonka.SSM.GetOpsSummary" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetOpsSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aggregators") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty OpsAggregator))) :: (S1 ('MetaSel ('Just "syncName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty OpsFilter))))) :: (S1 ('MetaSel ('Just "resultAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty OpsResultAttribute))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse GetOpsSummary Source #
Instance details Defined in Amazonka.SSM.GetOpsSummary type AWSResponse GetOpsSummary = GetOpsSummaryResponse

newGetOpsSummary :: GetOpsSummary Source #

Create a value of GetOpsSummary 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:aggregators:GetOpsSummary', getOpsSummary_aggregators - Optional aggregators that return counts of OpsData based on one or more expressions.

$sel:syncName:GetOpsSummary', getOpsSummary_syncName - Specify the name of a resource data sync to get.

$sel:filters:GetOpsSummary', getOpsSummary_filters - Optional filters used to scope down the returned OpsData.

$sel:resultAttributes:GetOpsSummary', getOpsSummary_resultAttributes - The OpsData data type to return.

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

$sel:maxResults:GetOpsSummary', getOpsSummary_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

getOpsSummary_aggregators :: Lens' GetOpsSummary (Maybe (NonEmpty OpsAggregator)) Source #

Optional aggregators that return counts of OpsData based on one or more expressions.

getOpsSummary_syncName :: Lens' GetOpsSummary (Maybe Text) Source #

Specify the name of a resource data sync to get.

getOpsSummary_filters :: Lens' GetOpsSummary (Maybe (NonEmpty OpsFilter)) Source #

Optional filters used to scope down the returned OpsData.

getOpsSummary_resultAttributes :: Lens' GetOpsSummary (Maybe (NonEmpty OpsResultAttribute)) Source #

The OpsData data type to return.

getOpsSummary_nextToken :: Lens' GetOpsSummary (Maybe Text) Source #

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

getOpsSummary_maxResults :: Lens' GetOpsSummary (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 GetOpsSummaryResponse Source #

See: newGetOpsSummaryResponse smart constructor.

Constructors

GetOpsSummaryResponse'
Fields entities :: Maybe [OpsEntity] The list of aggregated details and filtered OpsData. nextToken :: Maybe Text The token for the next set of items to return. Use this token to get the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetOpsSummaryResponse Source #

Arguments

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

Create a value of GetOpsSummaryResponse 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:entities:GetOpsSummaryResponse', getOpsSummaryResponse_entities - The list of aggregated details and filtered OpsData.

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

$sel:httpStatus:GetOpsSummaryResponse', getOpsSummaryResponse_httpStatus - The response's http status code.

Response Lenses

getOpsSummaryResponse_entities :: Lens' GetOpsSummaryResponse (Maybe [OpsEntity]) Source #

The list of aggregated details and filtered OpsData.

getOpsSummaryResponse_nextToken :: Lens' GetOpsSummaryResponse (Maybe Text) Source #

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

getOpsSummaryResponse_httpStatus :: Lens' GetOpsSummaryResponse Int Source #

The response's http status code.