Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.ListAssociations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You can limit the results to a specific State Manager association document or managed node by specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.

This operation returns paginated results.

Synopsis

data ListAssociations = ListAssociations' {
- associationFilterList :: Maybe (NonEmpty AssociationFilter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListAssociations :: ListAssociations
listAssociations_associationFilterList :: Lens' ListAssociations (Maybe (NonEmpty AssociationFilter))
listAssociations_maxResults :: Lens' ListAssociations (Maybe Natural)
listAssociations_nextToken :: Lens' ListAssociations (Maybe Text)
data ListAssociationsResponse = ListAssociationsResponse' {
- associations :: Maybe [Association]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAssociationsResponse :: Int -> ListAssociationsResponse
listAssociationsResponse_associations :: Lens' ListAssociationsResponse (Maybe [Association])
listAssociationsResponse_nextToken :: Lens' ListAssociationsResponse (Maybe Text)
listAssociationsResponse_httpStatus :: Lens' ListAssociationsResponse Int

Creating a Request

data ListAssociations Source #

See: newListAssociations smart constructor.

Constructors

ListAssociations'

Fields

associationFilterList :: Maybe (NonEmpty AssociationFilter)
One or more filters. Use a filter to return a more specific list of results.
Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the managed node that are part of the Target Attributes ResourceGroup or Tags aren't returned.
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.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)

Instances

Instances details

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

newListAssociations :: ListAssociations Source #

Create a value of ListAssociations 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:associationFilterList:ListAssociations', listAssociations_associationFilterList - One or more filters. Use a filter to return a more specific list of results.

Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the managed node that are part of the Target Attributes ResourceGroup or Tags aren't returned.

$sel:maxResults:ListAssociations', listAssociations_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.

ListAssociations, listAssociations_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

Request Lenses

listAssociations_associationFilterList :: Lens' ListAssociations (Maybe (NonEmpty AssociationFilter)) Source #

One or more filters. Use a filter to return a more specific list of results.

Filtering associations using the InstanceID attribute only returns legacy associations created using the InstanceID attribute. Associations targeting the managed node that are part of the Target Attributes ResourceGroup or Tags aren't returned.

listAssociations_maxResults :: Lens' ListAssociations (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.

listAssociations_nextToken :: Lens' ListAssociations (Maybe Text) Source #

The token for the next set of items to return. (You received this token from a previous call.)

Destructuring the Response

data ListAssociationsResponse Source #

See: newListAssociationsResponse smart constructor.

Constructors

ListAssociationsResponse'
Fields associations :: Maybe [Association] The associations. nextToken :: Maybe Text The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAssociationsResponse Source #

Arguments

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

Create a value of ListAssociationsResponse 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:associations:ListAssociationsResponse', listAssociationsResponse_associations - The associations.

ListAssociations, listAssociationsResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

$sel:httpStatus:ListAssociationsResponse', listAssociationsResponse_httpStatus - The response's http status code.

Response Lenses

listAssociationsResponse_associations :: Lens' ListAssociationsResponse (Maybe [Association]) Source #

The associations.

listAssociationsResponse_nextToken :: Lens' ListAssociationsResponse (Maybe Text) Source #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

listAssociationsResponse_httpStatus :: Lens' ListAssociationsResponse Int Source #

The response's http status code.