Amazonka.SSM.ListCommands

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

This operation returns paginated results.

Creating a Request

data ListCommands

See: newListCommands smart constructor.

Constructors

ListCommands'

Fields

• commandId :: Maybe Text

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

• filters :: Maybe (NonEmpty CommandFilter)

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

• instanceId :: Maybe Text

  (Optional) Lists commands issued against this managed node ID.

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

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

• nextToken :: Maybe Text

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

Instances

ToJSON ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

toJSON :: ListCommands -> Value

toEncoding :: ListCommands -> Encoding

toJSONList :: [ListCommands] -> Value

toEncodingList :: [ListCommands] -> Encoding

ToHeaders ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

toHeaders :: ListCommands -> [Header]

ToPath ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

toPath :: ListCommands -> ByteString

ToQuery ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

toQuery :: ListCommands -> QueryString

AWSPager ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

page :: ListCommands -> AWSResponse ListCommands -> Maybe ListCommands

AWSRequest ListCommands

Defined in Amazonka.SSM.ListCommands

Associated Types

type AWSResponse ListCommands

Methods

request :: (Service -> Service) -> ListCommands -> Request ListCommands

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCommands -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCommands)))

Generic ListCommands

Defined in Amazonka.SSM.ListCommands

Associated Types

type Rep ListCommands :: Type -> Type

Methods

from :: ListCommands -> Rep ListCommands x

to :: Rep ListCommands x -> ListCommands

Read ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

readsPrec :: Int -> ReadS ListCommands

readList :: ReadS [ListCommands]

readPrec :: ReadPrec ListCommands

readListPrec :: ReadPrec [ListCommands]

Show ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

showsPrec :: Int -> ListCommands -> ShowS

show :: ListCommands -> String

showList :: [ListCommands] -> ShowS

NFData ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

rnf :: ListCommands -> ()

Eq ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

(==) :: ListCommands -> ListCommands -> Bool

(/=) :: ListCommands -> ListCommands -> Bool

Hashable ListCommands

Defined in Amazonka.SSM.ListCommands

Methods

hashWithSalt :: Int -> ListCommands -> Int

hash :: ListCommands -> Int

type AWSResponse ListCommands

Defined in Amazonka.SSM.ListCommands

type AWSResponse ListCommands = ListCommandsResponse

type Rep ListCommands

Defined in Amazonka.SSM.ListCommands

type Rep ListCommands = D1 ('MetaData "ListCommands" "Amazonka.SSM.ListCommands" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListCommands'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "commandId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty CommandFilter)))) :*: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newListCommands :: ListCommands

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:

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

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

ListCommands, listCommands_instanceId - (Optional) Lists commands issued against this managed node ID.

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

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

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

Request Lenses

listCommands_commandId :: Lens' ListCommands (Maybe Text)

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

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

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

listCommands_instanceId :: Lens' ListCommands (Maybe Text)

(Optional) Lists commands issued against this managed node ID.

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

listCommands_maxResults :: Lens' ListCommands (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.

listCommands_nextToken :: Lens' ListCommands (Maybe Text)

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

Destructuring the Response

data ListCommandsResponse

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

Generic ListCommandsResponse

Defined in Amazonka.SSM.ListCommands

Associated Types

type Rep ListCommandsResponse :: Type -> Type

Methods

from :: ListCommandsResponse -> Rep ListCommandsResponse x

to :: Rep ListCommandsResponse x -> ListCommandsResponse

Show ListCommandsResponse

Defined in Amazonka.SSM.ListCommands

Methods

showsPrec :: Int -> ListCommandsResponse -> ShowS

show :: ListCommandsResponse -> String

showList :: [ListCommandsResponse] -> ShowS

NFData ListCommandsResponse

Defined in Amazonka.SSM.ListCommands

Methods

rnf :: ListCommandsResponse -> ()

Eq ListCommandsResponse

Defined in Amazonka.SSM.ListCommands

Methods

(==) :: ListCommandsResponse -> ListCommandsResponse -> Bool

(/=) :: ListCommandsResponse -> ListCommandsResponse -> Bool

type Rep ListCommandsResponse

Defined in Amazonka.SSM.ListCommands

type Rep ListCommandsResponse = D1 ('MetaData "ListCommandsResponse" "Amazonka.SSM.ListCommands" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" '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

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.

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])

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

listCommandsResponse_nextToken :: Lens' ListCommandsResponse (Maybe Text)

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

listCommandsResponse_httpStatus :: Lens' ListCommandsResponse Int

The response's http status code.