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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

An invocation is copy of a command sent to a specific managed node. A command can apply to one or more managed nodes. A command invocation applies to one managed node. For example, if a user runs SendCommand against three managed nodes, then a command invocation is created for each requested managed node 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

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.
filters :: Maybe (NonEmpty CommandFilter)
(Optional) One or more filters. Use a filter to return a more specific list of results.
instanceId :: Maybe Text
(Optional) The command execution details for a specific managed node ID.
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

Instances details

ToJSON ListCommandInvocations Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations Methods toJSON :: ListCommandInvocations -> Value # toEncoding :: ListCommandInvocations -> Encoding # toJSONList :: [ListCommandInvocations] -> Value # toEncodingList :: [ListCommandInvocations] -> Encoding #
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 #
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 :: (Service -> Service) -> ListCommandInvocations -> Request ListCommandInvocations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCommandInvocations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCommandInvocations))) #
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 #
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 #
NFData ListCommandInvocations Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations Methods rnf :: ListCommandInvocations -> () #
Eq ListCommandInvocations Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations Methods (==) :: ListCommandInvocations -> ListCommandInvocations -> Bool # (/=) :: ListCommandInvocations -> ListCommandInvocations -> Bool #
Hashable ListCommandInvocations Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations Methods hashWithSalt :: Int -> ListCommandInvocations -> Int # hash :: ListCommandInvocations -> Int #
type AWSResponse ListCommandInvocations Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations type AWSResponse ListCommandInvocations = ListCommandInvocationsResponse
type Rep ListCommandInvocations Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations type Rep ListCommandInvocations = D1 ('MetaData "ListCommandInvocations" "Amazonka.SSM.ListCommandInvocations" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListCommandInvocations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "commandId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: 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))))))

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:

ListCommandInvocations, listCommandInvocations_commandId - (Optional) The invocations for a specific command ID.

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

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

ListCommandInvocations, listCommandInvocations_instanceId - (Optional) The command execution details for a specific managed node ID.

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

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

Request Lenses

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_filters :: Lens' ListCommandInvocations (Maybe (NonEmpty CommandFilter)) Source #

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

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

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

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.

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

Destructuring the Response

data ListCommandInvocationsResponse Source #

See: newListCommandInvocationsResponse smart constructor.

Constructors

ListCommandInvocationsResponse'
Fields commandInvocations :: Maybe [CommandInvocation] (Optional) A list of all invocations. 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

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 #
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 #
NFData ListCommandInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations Methods rnf :: ListCommandInvocationsResponse -> () #
Eq ListCommandInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations Methods (==) :: ListCommandInvocationsResponse -> ListCommandInvocationsResponse -> Bool # (/=) :: ListCommandInvocationsResponse -> ListCommandInvocationsResponse -> Bool #
type Rep ListCommandInvocationsResponse Source #
Instance details Defined in Amazonka.SSM.ListCommandInvocations type Rep ListCommandInvocationsResponse = D1 ('MetaData "ListCommandInvocationsResponse" "Amazonka.SSM.ListCommandInvocations" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "ListCommandInvocationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "commandInvocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CommandInvocation])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:commandInvocations:ListCommandInvocationsResponse', listCommandInvocationsResponse_commandInvocations - (Optional) A list of all invocations.

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

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

Response Lenses

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

(Optional) A list of all invocations.

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_httpStatus :: Lens' ListCommandInvocationsResponse Int Source #

The response's http status code.