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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the commands requested by users of the Amazon Web Services account.

This operation returns paginated results.

Synopsis

data ListCommands = ListCommands' {
- instanceId :: Maybe Text
- filters :: Maybe (NonEmpty CommandFilter)
- nextToken :: Maybe Text
- commandId :: Maybe Text
- maxResults :: Maybe Natural
}
newListCommands :: ListCommands
listCommands_instanceId :: Lens' ListCommands (Maybe Text)
listCommands_filters :: Lens' ListCommands (Maybe (NonEmpty CommandFilter))
listCommands_nextToken :: Lens' ListCommands (Maybe Text)
listCommands_commandId :: Lens' ListCommands (Maybe Text)
listCommands_maxResults :: Lens' ListCommands (Maybe Natural)
data ListCommandsResponse = ListCommandsResponse' {
- commands :: Maybe [Command]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListCommandsResponse :: Int -> ListCommandsResponse
listCommandsResponse_commands :: Lens' ListCommandsResponse (Maybe [Command])
listCommandsResponse_nextToken :: Lens' ListCommandsResponse (Maybe Text)
listCommandsResponse_httpStatus :: Lens' ListCommandsResponse Int

Creating a Request

data ListCommands Source #

See: newListCommands smart constructor.

Constructors

ListCommands'

Fields

instanceId :: Maybe Text
(Optional) Lists commands issued against this instance ID.
You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command hasn't reached the instance yet.
filters :: Maybe (NonEmpty CommandFilter)
(Optional) One or more filters. Use a filter to return a more specific list of results.
nextToken :: Maybe Text
(Optional) The token for the next set of items to return. (You received this token from a previous call.)
commandId :: Maybe Text
(Optional) If provided, lists only the specified command.
maxResults :: Maybe Natural
(Optional) 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 ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods (==) :: ListCommands -> ListCommands -> Bool # (/=) :: ListCommands -> ListCommands -> Bool #
Read ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods readsPrec :: Int -> ReadS ListCommands # readList :: ReadS [ListCommands] # readPrec :: ReadPrec ListCommands # readListPrec :: ReadPrec [ListCommands] #
Show ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods showsPrec :: Int -> ListCommands -> ShowS # show :: ListCommands -> String # showList :: [ListCommands] -> ShowS #
Generic ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Associated Types type Rep ListCommands :: Type -> Type # Methods from :: ListCommands -> Rep ListCommands x # to :: Rep ListCommands x -> ListCommands #
NFData ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods rnf :: ListCommands -> () #
Hashable ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods hashWithSalt :: Int -> ListCommands -> Int # hash :: ListCommands -> Int #
ToJSON ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods toJSON :: ListCommands -> Value # toEncoding :: ListCommands -> Encoding # toJSONList :: [ListCommands] -> Value # toEncodingList :: [ListCommands] -> Encoding #
AWSPager ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods page :: ListCommands -> AWSResponse ListCommands -> Maybe ListCommands #
AWSRequest ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Associated Types type AWSResponse ListCommands # Methods request :: ListCommands -> Request ListCommands # response :: MonadResource m => Logger -> Service -> Proxy ListCommands -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCommands))) #
ToHeaders ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods toHeaders :: ListCommands -> [Header] #
ToPath ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods toPath :: ListCommands -> ByteString #
ToQuery ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands Methods toQuery :: ListCommands -> QueryString #
type Rep ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands type Rep ListCommands = D1 ('MetaData "ListCommands" "Amazonka.SSM.ListCommands" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListCommands'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty CommandFilter)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "commandId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListCommands Source #
Instance details Defined in Amazonka.SSM.ListCommands type AWSResponse ListCommands = ListCommandsResponse

newListCommands :: ListCommands Source #

Create a value of ListCommands 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:instanceId:ListCommands', listCommands_instanceId - (Optional) Lists commands issued against this instance ID.

You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command hasn't reached the instance yet.

$sel:filters:ListCommands', listCommands_filters - (Optional) One or more filters. Use a filter to return a more specific list of results.

$sel:nextToken:ListCommands', listCommands_nextToken - (Optional) The token for the next set of items to return. (You received this token from a previous call.)

$sel:commandId:ListCommands', listCommands_commandId - (Optional) If provided, lists only the specified command.

$sel:maxResults:ListCommands', listCommands_maxResults - (Optional) 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

listCommands_instanceId :: Lens' ListCommands (Maybe Text) Source #

(Optional) Lists commands issued against this instance ID.

You can't specify an instance ID in the same command that you specify Status = Pending. This is because the command hasn't reached the instance yet.

listCommands_filters :: Lens' ListCommands (Maybe (NonEmpty CommandFilter)) Source #

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

listCommands_nextToken :: Lens' ListCommands (Maybe Text) Source #

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

listCommands_commandId :: Lens' ListCommands (Maybe Text) Source #

(Optional) If provided, lists only the specified command.

listCommands_maxResults :: Lens' ListCommands (Maybe Natural) Source #

(Optional) 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 ListCommandsResponse Source #

See: newListCommandsResponse smart constructor.

Constructors

ListCommandsResponse'
Fields commands :: Maybe [Command] (Optional) The list of commands requested by the user. nextToken :: Maybe Text (Optional) The token for the next set of items to return. (You received this token from a previous call.) httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListCommandsResponse Source #

Arguments

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

Create a value of ListCommandsResponse 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:commands:ListCommandsResponse', listCommandsResponse_commands - (Optional) The list of commands requested by the user.

$sel:nextToken:ListCommands', listCommandsResponse_nextToken - (Optional) The token for the next set of items to return. (You received this token from a previous call.)

$sel:httpStatus:ListCommandsResponse', listCommandsResponse_httpStatus - The response's http status code.

Response Lenses

listCommandsResponse_commands :: Lens' ListCommandsResponse (Maybe [Command]) Source #

(Optional) The list of commands requested by the user.

listCommandsResponse_nextToken :: Lens' ListCommandsResponse (Maybe Text) Source #

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

listCommandsResponse_httpStatus :: Lens' ListCommandsResponse Int Source #

The response's http status code.