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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the framework details for the specified FrameworkName.

Synopsis

data DescribeFramework = DescribeFramework' {
- frameworkName :: Text
}
newDescribeFramework :: Text -> DescribeFramework
describeFramework_frameworkName :: Lens' DescribeFramework Text
data DescribeFrameworkResponse = DescribeFrameworkResponse' {
- creationTime :: Maybe POSIX
- deploymentStatus :: Maybe Text
- frameworkArn :: Maybe Text
- frameworkControls :: Maybe [FrameworkControl]
- frameworkDescription :: Maybe Text
- frameworkName :: Maybe Text
- frameworkStatus :: Maybe Text
- idempotencyToken :: Maybe Text
- httpStatus :: Int
}
newDescribeFrameworkResponse :: Int -> DescribeFrameworkResponse
describeFrameworkResponse_creationTime :: Lens' DescribeFrameworkResponse (Maybe UTCTime)
describeFrameworkResponse_deploymentStatus :: Lens' DescribeFrameworkResponse (Maybe Text)
describeFrameworkResponse_frameworkArn :: Lens' DescribeFrameworkResponse (Maybe Text)
describeFrameworkResponse_frameworkControls :: Lens' DescribeFrameworkResponse (Maybe [FrameworkControl])
describeFrameworkResponse_frameworkDescription :: Lens' DescribeFrameworkResponse (Maybe Text)
describeFrameworkResponse_frameworkName :: Lens' DescribeFrameworkResponse (Maybe Text)
describeFrameworkResponse_frameworkStatus :: Lens' DescribeFrameworkResponse (Maybe Text)
describeFrameworkResponse_idempotencyToken :: Lens' DescribeFrameworkResponse (Maybe Text)
describeFrameworkResponse_httpStatus :: Lens' DescribeFrameworkResponse Int

Creating a Request

data DescribeFramework Source #

See: newDescribeFramework smart constructor.

Constructors

DescribeFramework'
Fields frameworkName :: Text The unique name of a framework.

Instances

Instances details

ToHeaders DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods toHeaders :: DescribeFramework -> [Header] #
ToPath DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods toPath :: DescribeFramework -> ByteString #
ToQuery DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods toQuery :: DescribeFramework -> QueryString #
AWSRequest DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Associated Types type AWSResponse DescribeFramework # Methods request :: (Service -> Service) -> DescribeFramework -> Request DescribeFramework # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFramework -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFramework))) #
Generic DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Associated Types type Rep DescribeFramework :: Type -> Type # Methods from :: DescribeFramework -> Rep DescribeFramework x # to :: Rep DescribeFramework x -> DescribeFramework #
Read DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods readsPrec :: Int -> ReadS DescribeFramework # readList :: ReadS [DescribeFramework] # readPrec :: ReadPrec DescribeFramework # readListPrec :: ReadPrec [DescribeFramework] #
Show DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods showsPrec :: Int -> DescribeFramework -> ShowS # show :: DescribeFramework -> String # showList :: [DescribeFramework] -> ShowS #
NFData DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods rnf :: DescribeFramework -> () #
Eq DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods (==) :: DescribeFramework -> DescribeFramework -> Bool # (/=) :: DescribeFramework -> DescribeFramework -> Bool #
Hashable DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods hashWithSalt :: Int -> DescribeFramework -> Int # hash :: DescribeFramework -> Int #
type AWSResponse DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework type AWSResponse DescribeFramework = DescribeFrameworkResponse
type Rep DescribeFramework Source #
Instance details Defined in Amazonka.Backup.DescribeFramework type Rep DescribeFramework = D1 ('MetaData "DescribeFramework" "Amazonka.Backup.DescribeFramework" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DescribeFramework'" 'PrefixI 'True) (S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeFramework Source #

Arguments

:: Text	`DescribeFramework`
-> DescribeFramework

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:

DescribeFramework, describeFramework_frameworkName - The unique name of a framework.

Request Lenses

describeFramework_frameworkName :: Lens' DescribeFramework Text Source #

The unique name of a framework.

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 ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
deploymentStatus :: Maybe Text
The deployment status of a framework. The statuses are:
```
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
```
frameworkArn :: Maybe Text
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
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.
frameworkDescription :: Maybe Text
An optional description of the framework.
frameworkName :: Maybe Text
The unique name of a 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.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeFrameworkResponse Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Associated Types type Rep DescribeFrameworkResponse :: Type -> Type # Methods from :: DescribeFrameworkResponse -> Rep DescribeFrameworkResponse x # to :: Rep DescribeFrameworkResponse x -> DescribeFrameworkResponse #
Read DescribeFrameworkResponse Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods readsPrec :: Int -> ReadS DescribeFrameworkResponse # readList :: ReadS [DescribeFrameworkResponse] # readPrec :: ReadPrec DescribeFrameworkResponse # readListPrec :: ReadPrec [DescribeFrameworkResponse] #
Show DescribeFrameworkResponse Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods showsPrec :: Int -> DescribeFrameworkResponse -> ShowS # show :: DescribeFrameworkResponse -> String # showList :: [DescribeFrameworkResponse] -> ShowS #
NFData DescribeFrameworkResponse Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods rnf :: DescribeFrameworkResponse -> () #
Eq DescribeFrameworkResponse Source #
Instance details Defined in Amazonka.Backup.DescribeFramework Methods (==) :: DescribeFrameworkResponse -> DescribeFrameworkResponse -> Bool # (/=) :: DescribeFrameworkResponse -> DescribeFrameworkResponse -> Bool #
type Rep DescribeFrameworkResponse Source #
Instance details Defined in Amazonka.Backup.DescribeFramework type Rep DescribeFrameworkResponse = D1 ('MetaData "DescribeFrameworkResponse" "Amazonka.Backup.DescribeFramework" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "DescribeFrameworkResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "frameworkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "frameworkControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FrameworkControl])))) :: ((S1 ('MetaSel ('Just "frameworkDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "frameworkStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeFrameworkResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeFrameworkResponse'`
-> DescribeFrameworkResponse

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:

DescribeFrameworkResponse, describeFrameworkResponse_creationTime - The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

DescribeFrameworkResponse, describeFrameworkResponse_deploymentStatus - The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

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

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

DescribeFrameworkResponse, describeFrameworkResponse_frameworkDescription - An optional description of the framework.

DescribeFramework, describeFrameworkResponse_frameworkName - The unique name of a 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: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: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 ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

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

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_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_frameworkDescription :: Lens' DescribeFrameworkResponse (Maybe Text) Source #

An optional description of the framework.

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

The unique name of a framework.

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

The response's http status code.