libZSservicesZSamazonka-ssmZSamazonka-ssm
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSM.ListCommandInvocations

Description

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCommandInvocations Source #

See: newListCommandInvocations smart constructor.

Constructors

ListCommandInvocations' 

Fields

  • instanceId :: Maybe Text

    (Optional) The command execution details for a specific instance ID.

  • 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) The invocations for a specific command ID.

  • details :: Maybe Bool

    (Optional) If set this returns the response of the command executions and any command output. The default value is false.

  • 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 ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

(==) :: ListCommandInvocations -> ListCommandInvocations -> Bool #

(/=) :: ListCommandInvocations -> ListCommandInvocations -> Bool #

Read ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

readsPrec :: Int -> ReadS ListCommandInvocations #

readList :: ReadS [ListCommandInvocations] #

readPrec :: ReadPrec ListCommandInvocations #

readListPrec :: ReadPrec [ListCommandInvocations] #

Show ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

showsPrec :: Int -> ListCommandInvocations -> ShowS #

show :: ListCommandInvocations -> String #

showList :: [ListCommandInvocations] -> ShowS #

Generic ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Associated Types

type Rep ListCommandInvocations :: Type -> Type #

Methods

from :: ListCommandInvocations -> Rep ListCommandInvocations x #

to :: Rep ListCommandInvocations x -> ListCommandInvocations #

NFData ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

rnf :: ListCommandInvocations -> () #

Hashable ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

hashWithSalt :: Int -> ListCommandInvocations -> Int #

hash :: ListCommandInvocations -> Int #

ToJSON ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

toJSON :: ListCommandInvocations -> Value #

toEncoding :: ListCommandInvocations -> Encoding #

toJSONList :: [ListCommandInvocations] -> Value #

toEncodingList :: [ListCommandInvocations] -> Encoding #

AWSPager ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

page :: ListCommandInvocations -> AWSResponse ListCommandInvocations -> Maybe ListCommandInvocations #

AWSRequest ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Associated Types

type AWSResponse ListCommandInvocations #

Methods

request :: ListCommandInvocations -> Request ListCommandInvocations #

response :: MonadResource m => Logger -> Service -> Proxy ListCommandInvocations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCommandInvocations))) #

ToHeaders ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

toHeaders :: ListCommandInvocations -> [Header] #

ToPath ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

toPath :: ListCommandInvocations -> ByteString #

ToQuery ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

toQuery :: ListCommandInvocations -> QueryString #

type Rep ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

type Rep ListCommandInvocations = D1 ('MetaData "ListCommandInvocations" "Amazonka.SSM.ListCommandInvocations" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListCommandInvocations'" '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 "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListCommandInvocations Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

type AWSResponse ListCommandInvocations = ListCommandInvocationsResponse

newListCommandInvocations :: ListCommandInvocations Source #

Create a value of ListCommandInvocations 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:ListCommandInvocations', listCommandInvocations_instanceId - (Optional) The command execution details for a specific instance ID.

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

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

$sel:commandId:ListCommandInvocations', listCommandInvocations_commandId - (Optional) The invocations for a specific command ID.

$sel:details:ListCommandInvocations', listCommandInvocations_details - (Optional) If set this returns the response of the command executions and any command output. The default value is false.

$sel:maxResults:ListCommandInvocations', listCommandInvocations_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

listCommandInvocations_instanceId :: Lens' ListCommandInvocations (Maybe Text) Source #

(Optional) The command execution details for a specific instance ID.

listCommandInvocations_filters :: Lens' ListCommandInvocations (Maybe (NonEmpty CommandFilter)) Source #

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

listCommandInvocations_nextToken :: Lens' ListCommandInvocations (Maybe Text) Source #

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

listCommandInvocations_commandId :: Lens' ListCommandInvocations (Maybe Text) Source #

(Optional) The invocations for a specific command ID.

listCommandInvocations_details :: Lens' ListCommandInvocations (Maybe Bool) Source #

(Optional) If set this returns the response of the command executions and any command output. The default value is false.

listCommandInvocations_maxResults :: Lens' ListCommandInvocations (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 ListCommandInvocationsResponse Source #

See: newListCommandInvocationsResponse smart constructor.

Constructors

ListCommandInvocationsResponse' 

Fields

Instances

Instances details
Eq ListCommandInvocationsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

(==) :: ListCommandInvocationsResponse -> ListCommandInvocationsResponse -> Bool #

(/=) :: ListCommandInvocationsResponse -> ListCommandInvocationsResponse -> Bool #

Read ListCommandInvocationsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

readsPrec :: Int -> ReadS ListCommandInvocationsResponse #

readList :: ReadS [ListCommandInvocationsResponse] #

readPrec :: ReadPrec ListCommandInvocationsResponse #

readListPrec :: ReadPrec [ListCommandInvocationsResponse] #

Show ListCommandInvocationsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

showsPrec :: Int -> ListCommandInvocationsResponse -> ShowS #

show :: ListCommandInvocationsResponse -> String #

showList :: [ListCommandInvocationsResponse] -> ShowS #

Generic ListCommandInvocationsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Associated Types

type Rep ListCommandInvocationsResponse :: Type -> Type #

Methods

from :: ListCommandInvocationsResponse -> Rep ListCommandInvocationsResponse x #

to :: Rep ListCommandInvocationsResponse x -> ListCommandInvocationsResponse #

NFData ListCommandInvocationsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

Methods

rnf :: ListCommandInvocationsResponse -> () #

type Rep ListCommandInvocationsResponse Source # 
Instance details

Defined in Amazonka.SSM.ListCommandInvocations

type Rep ListCommandInvocationsResponse = D1 ('MetaData "ListCommandInvocationsResponse" "Amazonka.SSM.ListCommandInvocations" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "ListCommandInvocationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "commandInvocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CommandInvocation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCommandInvocationsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListCommandInvocationsResponse'

-> ListCommandInvocationsResponse 

Create a value of ListCommandInvocationsResponse 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:ListCommandInvocations', listCommandInvocationsResponse_nextToken - (Optional) The token for the next set of items to return. (You received this token from a previous call.)

$sel:commandInvocations:ListCommandInvocationsResponse', listCommandInvocationsResponse_commandInvocations - (Optional) A list of all invocations.

$sel:httpStatus:ListCommandInvocationsResponse', listCommandInvocationsResponse_httpStatus - The response's http status code.

Response Lenses

listCommandInvocationsResponse_nextToken :: Lens' ListCommandInvocationsResponse (Maybe Text) Source #

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

listCommandInvocationsResponse_commandInvocations :: Lens' ListCommandInvocationsResponse (Maybe [CommandInvocation]) Source #

(Optional) A list of all invocations.

listCommandInvocationsResponse_httpStatus :: Lens' ListCommandInvocationsResponse Int Source #

The response's http status code.