libZSservicesZSamazonka-backupZSamazonka-backup
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.Backup.UpdateFramework

Description

Updates an existing framework identified by its FrameworkName with the input document in JSON format.

Synopsis

Creating a Request

data UpdateFramework Source #

See: newUpdateFramework smart constructor.

Constructors

UpdateFramework' 

Fields

  • idempotencyToken :: Maybe Text

    A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

  • frameworkDescription :: Maybe Text

    An optional description of the framework with a maximum 1,024 characters.

  • frameworkControls :: Maybe [FrameworkControl]

    A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

  • frameworkName :: Text

    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Instances

Instances details
Eq UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Read UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Show UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Generic UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Associated Types

type Rep UpdateFramework :: Type -> Type #

NFData UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Methods

rnf :: UpdateFramework -> () #

Hashable UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

ToJSON UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

AWSRequest UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Associated Types

type AWSResponse UpdateFramework #

ToHeaders UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

ToPath UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

ToQuery UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

type Rep UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

type Rep UpdateFramework = D1 ('MetaData "UpdateFramework" "Amazonka.Backup.UpdateFramework" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "UpdateFramework'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "frameworkDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "frameworkControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FrameworkControl])) :*: S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse UpdateFramework Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

newUpdateFramework Source #

Create a value of UpdateFramework 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:idempotencyToken:UpdateFramework', updateFramework_idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

$sel:frameworkDescription:UpdateFramework', updateFramework_frameworkDescription - An optional description of the framework with a maximum 1,024 characters.

$sel:frameworkControls:UpdateFramework', updateFramework_frameworkControls - A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

$sel:frameworkName:UpdateFramework', updateFramework_frameworkName - The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Request Lenses

updateFramework_idempotencyToken :: Lens' UpdateFramework (Maybe Text) Source #

A customer-chosen string that you can use to distinguish between otherwise identical calls to UpdateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

updateFramework_frameworkDescription :: Lens' UpdateFramework (Maybe Text) Source #

An optional description of the framework with a maximum 1,024 characters.

updateFramework_frameworkControls :: Lens' UpdateFramework (Maybe [FrameworkControl]) Source #

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

updateFramework_frameworkName :: Lens' UpdateFramework Text Source #

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Destructuring the Response

data UpdateFrameworkResponse Source #

See: newUpdateFrameworkResponse smart constructor.

Constructors

UpdateFrameworkResponse' 

Fields

  • creationTime :: Maybe POSIX

    The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

  • frameworkArn :: Maybe Text

    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

  • frameworkName :: Maybe Text

    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq UpdateFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Read UpdateFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Show UpdateFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Generic UpdateFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Associated Types

type Rep UpdateFrameworkResponse :: Type -> Type #

NFData UpdateFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

Methods

rnf :: UpdateFrameworkResponse -> () #

type Rep UpdateFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.UpdateFramework

type Rep UpdateFrameworkResponse = D1 ('MetaData "UpdateFrameworkResponse" "Amazonka.Backup.UpdateFramework" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "UpdateFrameworkResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "frameworkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateFrameworkResponse Source #

Create a value of UpdateFrameworkResponse 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:creationTime:UpdateFrameworkResponse', updateFrameworkResponse_creationTime - The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

$sel:frameworkArn:UpdateFrameworkResponse', updateFrameworkResponse_frameworkArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

$sel:frameworkName:UpdateFramework', updateFrameworkResponse_frameworkName - The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

$sel:httpStatus:UpdateFrameworkResponse', updateFrameworkResponse_httpStatus - The response's http status code.

Response Lenses

updateFrameworkResponse_creationTime :: Lens' UpdateFrameworkResponse (Maybe UTCTime) Source #

The date and time that a framework is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

updateFrameworkResponse_frameworkArn :: Lens' UpdateFrameworkResponse (Maybe Text) Source #

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

updateFrameworkResponse_frameworkName :: Lens' UpdateFrameworkResponse (Maybe Text) Source #

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).