Amazonka.Config.StartRemediationExecution

Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.

You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.

Creating a Request

data StartRemediationExecution

See: newStartRemediationExecution smart constructor.

Constructors

StartRemediationExecution'

Fields

• configRuleName :: Text

  The list of names of Config rules that you want to run remediation execution for.

• resourceKeys :: NonEmpty ResourceKey

  A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Instances

ToJSON StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

toJSON :: StartRemediationExecution -> Value

toEncoding :: StartRemediationExecution -> Encoding

toJSONList :: [StartRemediationExecution] -> Value

toEncodingList :: [StartRemediationExecution] -> Encoding

ToHeaders StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

toHeaders :: StartRemediationExecution -> [Header]

ToPath StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

toPath :: StartRemediationExecution -> ByteString

ToQuery StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

toQuery :: StartRemediationExecution -> QueryString

AWSRequest StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Associated Types

type AWSResponse StartRemediationExecution

Methods

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

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

Generic StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Associated Types

type Rep StartRemediationExecution :: Type -> Type

Methods

from :: StartRemediationExecution -> Rep StartRemediationExecution x

to :: Rep StartRemediationExecution x -> StartRemediationExecution

Read StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

readsPrec :: Int -> ReadS StartRemediationExecution

readList :: ReadS [StartRemediationExecution]

readPrec :: ReadPrec StartRemediationExecution

readListPrec :: ReadPrec [StartRemediationExecution]

Show StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

showsPrec :: Int -> StartRemediationExecution -> ShowS

show :: StartRemediationExecution -> String

showList :: [StartRemediationExecution] -> ShowS

NFData StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

rnf :: StartRemediationExecution -> ()

Eq StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

(==) :: StartRemediationExecution -> StartRemediationExecution -> Bool

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

Hashable StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

Methods

hashWithSalt :: Int -> StartRemediationExecution -> Int

hash :: StartRemediationExecution -> Int

type AWSResponse StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

type AWSResponse StartRemediationExecution = StartRemediationExecutionResponse

type Rep StartRemediationExecution

Defined in Amazonka.Config.StartRemediationExecution

type Rep StartRemediationExecution = D1 ('MetaData "StartRemediationExecution" "Amazonka.Config.StartRemediationExecution" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "StartRemediationExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configRuleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty ResourceKey))))

newStartRemediationExecution

Arguments

:: Text

StartRemediationExecution

-> NonEmpty ResourceKey

$sel:resourceKeys:StartRemediationExecution'

-> StartRemediationExecution

Create a value of StartRemediationExecution 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:

StartRemediationExecution, startRemediationExecution_configRuleName - The list of names of Config rules that you want to run remediation execution for.

$sel:resourceKeys:StartRemediationExecution', startRemediationExecution_resourceKeys - A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Request Lenses

startRemediationExecution_configRuleName :: Lens' StartRemediationExecution Text

The list of names of Config rules that you want to run remediation execution for.

startRemediationExecution_resourceKeys :: Lens' StartRemediationExecution (NonEmpty ResourceKey)

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Destructuring the Response

data StartRemediationExecutionResponse

See: newStartRemediationExecutionResponse smart constructor.

Constructors

StartRemediationExecutionResponse'

Fields

• failedItems :: Maybe (NonEmpty ResourceKey)

  For resources that have failed to start execution, the API returns a resource key object.

• failureMessage :: Maybe Text

  Returns a failure message. For example, the resource is already compliant.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartRemediationExecutionResponse

Defined in Amazonka.Config.StartRemediationExecution

Associated Types

type Rep StartRemediationExecutionResponse :: Type -> Type

Methods

from :: StartRemediationExecutionResponse -> Rep StartRemediationExecutionResponse x

to :: Rep StartRemediationExecutionResponse x -> StartRemediationExecutionResponse

Read StartRemediationExecutionResponse

Defined in Amazonka.Config.StartRemediationExecution

Methods

readsPrec :: Int -> ReadS StartRemediationExecutionResponse

readList :: ReadS [StartRemediationExecutionResponse]

readPrec :: ReadPrec StartRemediationExecutionResponse

readListPrec :: ReadPrec [StartRemediationExecutionResponse]

Show StartRemediationExecutionResponse

Defined in Amazonka.Config.StartRemediationExecution

Methods

showsPrec :: Int -> StartRemediationExecutionResponse -> ShowS

show :: StartRemediationExecutionResponse -> String

showList :: [StartRemediationExecutionResponse] -> ShowS

NFData StartRemediationExecutionResponse

Defined in Amazonka.Config.StartRemediationExecution

Methods

rnf :: StartRemediationExecutionResponse -> ()

Eq StartRemediationExecutionResponse

Defined in Amazonka.Config.StartRemediationExecution

Methods

(==) :: StartRemediationExecutionResponse -> StartRemediationExecutionResponse -> Bool

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

type Rep StartRemediationExecutionResponse

Defined in Amazonka.Config.StartRemediationExecution

type Rep StartRemediationExecutionResponse = D1 ('MetaData "StartRemediationExecutionResponse" "Amazonka.Config.StartRemediationExecution" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "StartRemediationExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failedItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourceKey))) :*: (S1 ('MetaSel ('Just "failureMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartRemediationExecutionResponse

Arguments

:: Int

$sel:httpStatus:StartRemediationExecutionResponse'

-> StartRemediationExecutionResponse

Create a value of StartRemediationExecutionResponse 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:

StartRemediationExecutionResponse, startRemediationExecutionResponse_failedItems - For resources that have failed to start execution, the API returns a resource key object.

StartRemediationExecutionResponse, startRemediationExecutionResponse_failureMessage - Returns a failure message. For example, the resource is already compliant.

$sel:httpStatus:StartRemediationExecutionResponse', startRemediationExecutionResponse_httpStatus - The response's http status code.

Response Lenses

startRemediationExecutionResponse_failedItems :: Lens' StartRemediationExecutionResponse (Maybe (NonEmpty ResourceKey))

For resources that have failed to start execution, the API returns a resource key object.

startRemediationExecutionResponse_failureMessage :: Lens' StartRemediationExecutionResponse (Maybe Text)

Returns a failure message. For example, the resource is already compliant.

startRemediationExecutionResponse_httpStatus :: Lens' StartRemediationExecutionResponse Int

The response's http status code.