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

Description

Returns the framework details for the specified FrameworkName.

Synopsis

Creating a Request

data DescribeFramework Source #

See: newDescribeFramework smart constructor.

Constructors

DescribeFramework' 

Fields

Instances

Instances details
Eq DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Read DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Show DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Generic DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Associated Types

type Rep DescribeFramework :: Type -> Type #

NFData DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Methods

rnf :: DescribeFramework -> () #

Hashable DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

AWSRequest DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Associated Types

type AWSResponse DescribeFramework #

ToHeaders DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

ToPath DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

ToQuery DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

type Rep DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

type Rep DescribeFramework = D1 ('MetaData "DescribeFramework" "Amazonka.Backup.DescribeFramework" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "DescribeFramework'" 'PrefixI 'True) (S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeFramework Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

newDescribeFramework Source #

Create a value of DescribeFramework 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:frameworkName:DescribeFramework', describeFramework_frameworkName - The unique name of a framework.

Request Lenses

Destructuring the Response

data DescribeFrameworkResponse Source #

See: newDescribeFrameworkResponse smart constructor.

Constructors

DescribeFrameworkResponse' 

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.

  • idempotencyToken :: Maybe Text

    A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. 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.

  • frameworkStatus :: Maybe Text

    A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

    • ACTIVE when recording is turned on for all resources governed by the framework.
    • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
    • INACTIVE when recording is turned off for all resources governed by the framework.
    • UNAVAILABLE when Backup is unable to validate recording status at this time.
  • 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.

  • frameworkArn :: Maybe Text

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

  • deploymentStatus :: Maybe Text

    The deployment status of a framework. The statuses are:

    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
  • frameworkName :: Maybe Text

    The unique name of a framework.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Read DescribeFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Show DescribeFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Generic DescribeFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

Associated Types

type Rep DescribeFrameworkResponse :: Type -> Type #

NFData DescribeFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

type Rep DescribeFrameworkResponse Source # 
Instance details

Defined in Amazonka.Backup.DescribeFramework

type Rep DescribeFrameworkResponse = D1 ('MetaData "DescribeFrameworkResponse" "Amazonka.Backup.DescribeFramework" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "DescribeFrameworkResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "frameworkDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "frameworkStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "frameworkControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FrameworkControl])) :*: S1 ('MetaSel ('Just "frameworkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "deploymentStatus") '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))))))

newDescribeFrameworkResponse Source #

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

$sel:frameworkDescription:DescribeFrameworkResponse', describeFrameworkResponse_frameworkDescription - An optional description of the framework.

$sel:frameworkStatus:DescribeFrameworkResponse', describeFrameworkResponse_frameworkStatus - A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

  • ACTIVE when recording is turned on for all resources governed by the framework.
  • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
  • INACTIVE when recording is turned off for all resources governed by the framework.
  • UNAVAILABLE when Backup is unable to validate recording status at this time.

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

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

$sel:deploymentStatus:DescribeFrameworkResponse', describeFrameworkResponse_deploymentStatus - The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

$sel:frameworkName:DescribeFramework', describeFrameworkResponse_frameworkName - The unique name of a framework.

$sel:httpStatus:DescribeFrameworkResponse', describeFrameworkResponse_httpStatus - The response's http status code.

Response Lenses

describeFrameworkResponse_creationTime :: Lens' DescribeFrameworkResponse (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.

describeFrameworkResponse_idempotencyToken :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

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

describeFrameworkResponse_frameworkStatus :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

  • ACTIVE when recording is turned on for all resources governed by the framework.
  • PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
  • INACTIVE when recording is turned off for all resources governed by the framework.
  • UNAVAILABLE when Backup is unable to validate recording status at this time.

describeFrameworkResponse_frameworkControls :: Lens' DescribeFrameworkResponse (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.

describeFrameworkResponse_frameworkArn :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

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

describeFrameworkResponse_deploymentStatus :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED