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.Types.CommandFilter

Description

Synopsis

data CommandFilter = CommandFilter' {
- key :: CommandFilterKey
- value :: Text
}
newCommandFilter :: CommandFilterKey -> Text -> CommandFilter
commandFilter_key :: Lens' CommandFilter CommandFilterKey
commandFilter_value :: Lens' CommandFilter Text

Documentation

data CommandFilter Source #

Describes a command filter.

An instance ID can't be specified when a command status is Pending because the command hasn't run on the instance yet.

See: newCommandFilter smart constructor.

Constructors

CommandFilter'

Fields

key :: CommandFilterKey
The name of the filter.
value :: Text
The filter value. Valid values for each filter key are as follows:
- InvokedAfter: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, and later.
- InvokedBefore: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions from before July 7, 2021.
- Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.
  The status values you can specify for ListCommands are:
  - ```
  Pending
```
- ```
InProgress
```
  - ```
  Success
```
- ```
Cancelled
```
  - ```
  Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
  - ```
  DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
  - ```
  Incomplete
```
- ```
NoInstancesInTag
```
  - ```
  LimitExceeded
```
The status values you can specify for ListCommandInvocations are:
- ```
Pending
```
  - ```
  InProgress
```
- ```
Delayed
```
  - ```
  Success
```
- ```
Cancelled
```
  - ```
  Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
  - ```
  DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
  - ```
  Undeliverable
```
- ```
InvalidPlatform
```
  - ```
  Terminated
```
- DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.
- ExecutionStage: Specify one of the following values:
  - Executing: Returns a list of command executions that are currently still running.
  - Complete: Returns a list of command executions that have already completed.

Instances

Instances details

Eq CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter Methods (==) :: CommandFilter -> CommandFilter -> Bool # (/=) :: CommandFilter -> CommandFilter -> Bool #
Read CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter Methods readsPrec :: Int -> ReadS CommandFilter # readList :: ReadS [CommandFilter] # readPrec :: ReadPrec CommandFilter # readListPrec :: ReadPrec [CommandFilter] #
Show CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter Methods showsPrec :: Int -> CommandFilter -> ShowS # show :: CommandFilter -> String # showList :: [CommandFilter] -> ShowS #
Generic CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter Associated Types type Rep CommandFilter :: Type -> Type # Methods from :: CommandFilter -> Rep CommandFilter x # to :: Rep CommandFilter x -> CommandFilter #
NFData CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter Methods rnf :: CommandFilter -> () #
Hashable CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter Methods hashWithSalt :: Int -> CommandFilter -> Int # hash :: CommandFilter -> Int #
ToJSON CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter Methods toJSON :: CommandFilter -> Value # toEncoding :: CommandFilter -> Encoding # toJSONList :: [CommandFilter] -> Value # toEncodingList :: [CommandFilter] -> Encoding #
type Rep CommandFilter Source #
Instance details Defined in Amazonka.SSM.Types.CommandFilter type Rep CommandFilter = D1 ('MetaData "CommandFilter" "Amazonka.SSM.Types.CommandFilter" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "CommandFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CommandFilterKey) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCommandFilter Source #

Arguments

:: CommandFilterKey	`$sel:key:CommandFilter'`
-> Text	`$sel:value:CommandFilter'`
-> CommandFilter

Create a value of CommandFilter 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:key:CommandFilter', commandFilter_key - The name of the filter.

$sel:value:CommandFilter', commandFilter_value - The filter value. Valid values for each filter key are as follows:

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions from before July 7, 2021.
Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.
The status values you can specify for ListCommands are:
- ```
Pending
```
- ```
InProgress
```
- ```
Success
```
- ```
Cancelled
```
- ```
Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
- ```
DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
- ```
Incomplete
```
- ```
NoInstancesInTag
```
- ```
LimitExceeded
```
The status values you can specify for ListCommandInvocations are:
- ```
Pending
```
- ```
InProgress
```
- ```
Delayed
```
- ```
Success
```
- ```
Cancelled
```
- ```
Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
- ```
DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
- ```
Undeliverable
```
- ```
InvalidPlatform
```
- ```
Terminated
```
DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.
ExecutionStage: Specify one of the following values:
- Executing: Returns a list of command executions that are currently still running.
- Complete: Returns a list of command executions that have already completed.

commandFilter_key :: Lens' CommandFilter CommandFilterKey Source #

The name of the filter.

commandFilter_value :: Lens' CommandFilter Text Source #

The filter value. Valid values for each filter key are as follows:

InvokedAfter: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions occurring July 7, 2021, and later.
InvokedBefore: Specify a timestamp to limit your results. For example, specify 2021-07-07T00:00:00Z to see a list of command executions from before July 7, 2021.
Status: Specify a valid command status to see a list of all command executions with that status. The status choices depend on the API you call.
The status values you can specify for ListCommands are:
- ```
Pending
```
- ```
InProgress
```
- ```
Success
```
- ```
Cancelled
```
- ```
Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
- ```
DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
- ```
Incomplete
```
- ```
NoInstancesInTag
```
- ```
LimitExceeded
```
The status values you can specify for ListCommandInvocations are:
- ```
Pending
```
- ```
InProgress
```
- ```
Delayed
```
- ```
Success
```
- ```
Cancelled
```
- ```
Failed
```
- TimedOut (this includes both Delivery and Execution time outs)
- ```
AccessDenied
```
- ```
DeliveryTimedOut
```
- ```
ExecutionTimedOut
```
- ```
Undeliverable
```
- ```
InvalidPlatform
```
- ```
Terminated
```
DocumentName: Specify name of the Amazon Web Services Systems Manager document (SSM document) for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.
ExecutionStage: Specify one of the following values:
- Executing: Returns a list of command executions that are currently still running.
- Complete: Returns a list of command executions that have already completed.