Amazonka.DynamoDB.DescribeBackup

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

Creating a Request

data DescribeBackup

See: newDescribeBackup smart constructor.

Constructors

DescribeBackup'

Fields

• backupArn :: Text

  The Amazon Resource Name (ARN) associated with the backup.

Instances

ToJSON DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

toJSON :: DescribeBackup -> Value

toEncoding :: DescribeBackup -> Encoding

toJSONList :: [DescribeBackup] -> Value

toEncodingList :: [DescribeBackup] -> Encoding

ToHeaders DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

toHeaders :: DescribeBackup -> [Header]

ToPath DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

toPath :: DescribeBackup -> ByteString

ToQuery DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

toQuery :: DescribeBackup -> QueryString

AWSRequest DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Associated Types

type AWSResponse DescribeBackup

Methods

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

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

Generic DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Associated Types

type Rep DescribeBackup :: Type -> Type

Methods

from :: DescribeBackup -> Rep DescribeBackup x

to :: Rep DescribeBackup x -> DescribeBackup

Read DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

readsPrec :: Int -> ReadS DescribeBackup

readList :: ReadS [DescribeBackup]

readPrec :: ReadPrec DescribeBackup

readListPrec :: ReadPrec [DescribeBackup]

Show DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

showsPrec :: Int -> DescribeBackup -> ShowS

show :: DescribeBackup -> String

showList :: [DescribeBackup] -> ShowS

NFData DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

rnf :: DescribeBackup -> ()

Eq DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

(==) :: DescribeBackup -> DescribeBackup -> Bool

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

Hashable DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

hashWithSalt :: Int -> DescribeBackup -> Int

hash :: DescribeBackup -> Int

type AWSResponse DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

type AWSResponse DescribeBackup = DescribeBackupResponse

type Rep DescribeBackup

Defined in Amazonka.DynamoDB.DescribeBackup

type Rep DescribeBackup = D1 ('MetaData "DescribeBackup" "Amazonka.DynamoDB.DescribeBackup" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DescribeBackup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeBackup

Arguments

:: Text

DescribeBackup

-> DescribeBackup

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

DescribeBackup, describeBackup_backupArn - The Amazon Resource Name (ARN) associated with the backup.

Request Lenses

describeBackup_backupArn :: Lens' DescribeBackup Text

The Amazon Resource Name (ARN) associated with the backup.

Destructuring the Response

data DescribeBackupResponse

See: newDescribeBackupResponse smart constructor.

Constructors

DescribeBackupResponse'

Fields

• backupDescription :: Maybe BackupDescription

  Contains the description of the backup created for the table.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeBackupResponse

Defined in Amazonka.DynamoDB.DescribeBackup

Associated Types

type Rep DescribeBackupResponse :: Type -> Type

Methods

from :: DescribeBackupResponse -> Rep DescribeBackupResponse x

to :: Rep DescribeBackupResponse x -> DescribeBackupResponse

Read DescribeBackupResponse

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

readsPrec :: Int -> ReadS DescribeBackupResponse

readList :: ReadS [DescribeBackupResponse]

readPrec :: ReadPrec DescribeBackupResponse

readListPrec :: ReadPrec [DescribeBackupResponse]

Show DescribeBackupResponse

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

showsPrec :: Int -> DescribeBackupResponse -> ShowS

show :: DescribeBackupResponse -> String

showList :: [DescribeBackupResponse] -> ShowS

NFData DescribeBackupResponse

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

rnf :: DescribeBackupResponse -> ()

Eq DescribeBackupResponse

Defined in Amazonka.DynamoDB.DescribeBackup

Methods

(==) :: DescribeBackupResponse -> DescribeBackupResponse -> Bool

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

type Rep DescribeBackupResponse

Defined in Amazonka.DynamoDB.DescribeBackup

type Rep DescribeBackupResponse = D1 ('MetaData "DescribeBackupResponse" "Amazonka.DynamoDB.DescribeBackup" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "DescribeBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeBackupResponse

Arguments

:: Int

$sel:httpStatus:DescribeBackupResponse'

-> DescribeBackupResponse

Create a value of DescribeBackupResponse 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:backupDescription:DescribeBackupResponse', describeBackupResponse_backupDescription - Contains the description of the backup created for the table.

$sel:httpStatus:DescribeBackupResponse', describeBackupResponse_httpStatus - The response's http status code.

Response Lenses

describeBackupResponse_backupDescription :: Lens' DescribeBackupResponse (Maybe BackupDescription)

Contains the description of the backup created for the table.

describeBackupResponse_httpStatus :: Lens' DescribeBackupResponse Int

The response's http status code.