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.ServiceCatalog.DescribeRecord

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the specified request operation.

Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.

Synopsis

data DescribeRecord = DescribeRecord' {
- acceptLanguage :: Maybe Text
- pageSize :: Maybe Natural
- pageToken :: Maybe Text
- id :: Text
}
newDescribeRecord :: Text -> DescribeRecord
describeRecord_acceptLanguage :: Lens' DescribeRecord (Maybe Text)
describeRecord_pageSize :: Lens' DescribeRecord (Maybe Natural)
describeRecord_pageToken :: Lens' DescribeRecord (Maybe Text)
describeRecord_id :: Lens' DescribeRecord Text
data DescribeRecordResponse = DescribeRecordResponse' {
- nextPageToken :: Maybe Text
- recordDetail :: Maybe RecordDetail
- recordOutputs :: Maybe [RecordOutput]
- httpStatus :: Int
}
newDescribeRecordResponse :: Int -> DescribeRecordResponse
describeRecordResponse_nextPageToken :: Lens' DescribeRecordResponse (Maybe Text)
describeRecordResponse_recordDetail :: Lens' DescribeRecordResponse (Maybe RecordDetail)
describeRecordResponse_recordOutputs :: Lens' DescribeRecordResponse (Maybe [RecordOutput])
describeRecordResponse_httpStatus :: Lens' DescribeRecordResponse Int

Creating a Request

data DescribeRecord Source #

See: newDescribeRecord smart constructor.

Constructors

DescribeRecord'

Fields

acceptLanguage :: Maybe Text
The language code.
- en - English (default)
- jp - Japanese
- zh - Chinese
pageSize :: Maybe Natural
The maximum number of items to return with this call.
pageToken :: Maybe Text
The page token for the next set of results. To retrieve the first set of results, use null.
id :: Text
The record identifier of the provisioned product. This identifier is returned by the request operation.

Instances

Instances details

ToJSON DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods toJSON :: DescribeRecord -> Value # toEncoding :: DescribeRecord -> Encoding # toJSONList :: [DescribeRecord] -> Value # toEncodingList :: [DescribeRecord] -> Encoding #
ToHeaders DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods toHeaders :: DescribeRecord -> [Header] #
ToPath DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods toPath :: DescribeRecord -> ByteString #
ToQuery DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods toQuery :: DescribeRecord -> QueryString #
AWSRequest DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Associated Types type AWSResponse DescribeRecord # Methods request :: (Service -> Service) -> DescribeRecord -> Request DescribeRecord # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRecord -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRecord))) #
Generic DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Associated Types type Rep DescribeRecord :: Type -> Type # Methods from :: DescribeRecord -> Rep DescribeRecord x # to :: Rep DescribeRecord x -> DescribeRecord #
Read DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods readsPrec :: Int -> ReadS DescribeRecord # readList :: ReadS [DescribeRecord] # readPrec :: ReadPrec DescribeRecord # readListPrec :: ReadPrec [DescribeRecord] #
Show DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods showsPrec :: Int -> DescribeRecord -> ShowS # show :: DescribeRecord -> String # showList :: [DescribeRecord] -> ShowS #
NFData DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods rnf :: DescribeRecord -> () #
Eq DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods (==) :: DescribeRecord -> DescribeRecord -> Bool # (/=) :: DescribeRecord -> DescribeRecord -> Bool #
Hashable DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods hashWithSalt :: Int -> DescribeRecord -> Int # hash :: DescribeRecord -> Int #
type AWSResponse DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord type AWSResponse DescribeRecord = DescribeRecordResponse
type Rep DescribeRecord Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord type Rep DescribeRecord = D1 ('MetaData "DescribeRecord" "Amazonka.ServiceCatalog.DescribeRecord" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "DescribeRecord'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeRecord Source #

Arguments

:: Text	`DescribeRecord`
-> DescribeRecord

Create a value of DescribeRecord 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:acceptLanguage:DescribeRecord', describeRecord_acceptLanguage - The language code.

en - English (default)
jp - Japanese
zh - Chinese

$sel:pageSize:DescribeRecord', describeRecord_pageSize - The maximum number of items to return with this call.

$sel:pageToken:DescribeRecord', describeRecord_pageToken - The page token for the next set of results. To retrieve the first set of results, use null.

DescribeRecord, describeRecord_id - The record identifier of the provisioned product. This identifier is returned by the request operation.

Request Lenses

describeRecord_acceptLanguage :: Lens' DescribeRecord (Maybe Text) Source #

The language code.

en - English (default)
jp - Japanese
zh - Chinese

describeRecord_pageSize :: Lens' DescribeRecord (Maybe Natural) Source #

The maximum number of items to return with this call.

describeRecord_pageToken :: Lens' DescribeRecord (Maybe Text) Source #

The page token for the next set of results. To retrieve the first set of results, use null.

describeRecord_id :: Lens' DescribeRecord Text Source #

The record identifier of the provisioned product. This identifier is returned by the request operation.

Destructuring the Response

data DescribeRecordResponse Source #

See: newDescribeRecordResponse smart constructor.

Constructors

DescribeRecordResponse'

Fields

nextPageToken :: Maybe Text
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
recordDetail :: Maybe RecordDetail
Information about the product.
recordOutputs :: Maybe [RecordOutput]
Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeRecordResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Associated Types type Rep DescribeRecordResponse :: Type -> Type # Methods from :: DescribeRecordResponse -> Rep DescribeRecordResponse x # to :: Rep DescribeRecordResponse x -> DescribeRecordResponse #
Read DescribeRecordResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods readsPrec :: Int -> ReadS DescribeRecordResponse # readList :: ReadS [DescribeRecordResponse] # readPrec :: ReadPrec DescribeRecordResponse # readListPrec :: ReadPrec [DescribeRecordResponse] #
Show DescribeRecordResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods showsPrec :: Int -> DescribeRecordResponse -> ShowS # show :: DescribeRecordResponse -> String # showList :: [DescribeRecordResponse] -> ShowS #
NFData DescribeRecordResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods rnf :: DescribeRecordResponse -> () #
Eq DescribeRecordResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord Methods (==) :: DescribeRecordResponse -> DescribeRecordResponse -> Bool # (/=) :: DescribeRecordResponse -> DescribeRecordResponse -> Bool #
type Rep DescribeRecordResponse Source #
Instance details Defined in Amazonka.ServiceCatalog.DescribeRecord type Rep DescribeRecordResponse = D1 ('MetaData "DescribeRecordResponse" "Amazonka.ServiceCatalog.DescribeRecord" "amazonka-servicecatalog-2.0-HQc7wwDA1XY4nlo6issXoI" 'False) (C1 ('MetaCons "DescribeRecordResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recordDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecordDetail))) :: (S1 ('MetaSel ('Just "recordOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecordOutput])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeRecordResponse Source #

Arguments

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

Create a value of DescribeRecordResponse 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:nextPageToken:DescribeRecordResponse', describeRecordResponse_nextPageToken - The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

$sel:recordDetail:DescribeRecordResponse', describeRecordResponse_recordDetail - Information about the product.

$sel:recordOutputs:DescribeRecordResponse', describeRecordResponse_recordOutputs - Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

$sel:httpStatus:DescribeRecordResponse', describeRecordResponse_httpStatus - The response's http status code.

Response Lenses

describeRecordResponse_nextPageToken :: Lens' DescribeRecordResponse (Maybe Text) Source #

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

describeRecordResponse_recordDetail :: Lens' DescribeRecordResponse (Maybe RecordDetail) Source #

Information about the product.

describeRecordResponse_recordOutputs :: Lens' DescribeRecordResponse (Maybe [RecordOutput]) Source #

Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

describeRecordResponse_httpStatus :: Lens' DescribeRecordResponse Int Source #

The response's http status code.