libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog
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.ServiceCatalog.DescribeRecord

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

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
  • pageToken :: Maybe Text

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

  • pageSize :: Maybe Natural

    The maximum number of items to return with this call.

  • id :: Text

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

Instances

Instances details
Eq DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Read DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Show DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Generic DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Associated Types

type Rep DescribeRecord :: Type -> Type #

NFData DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Methods

rnf :: DescribeRecord -> () #

Hashable DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

ToJSON DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

AWSRequest DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Associated Types

type AWSResponse DescribeRecord #

ToHeaders DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

ToPath DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

ToQuery DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

type Rep DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

type Rep DescribeRecord = D1 ('MetaData "DescribeRecord" "Amazonka.ServiceCatalog.DescribeRecord" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "DescribeRecord'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acceptLanguage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DescribeRecord Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

newDescribeRecord Source #

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:pageToken:DescribeRecord', describeRecord_pageToken - The page token for the next set of results. To retrieve the first set of results, use null.

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

$sel:id: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_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_pageSize :: Lens' DescribeRecord (Maybe Natural) Source #

The maximum number of items to return with this call.

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

  • recordDetail :: Maybe RecordDetail

    Information about the product.

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

  • 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
Eq DescribeRecordResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Read DescribeRecordResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Show DescribeRecordResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Generic DescribeRecordResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Associated Types

type Rep DescribeRecordResponse :: Type -> Type #

NFData DescribeRecordResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

Methods

rnf :: DescribeRecordResponse -> () #

type Rep DescribeRecordResponse Source # 
Instance details

Defined in Amazonka.ServiceCatalog.DescribeRecord

type Rep DescribeRecordResponse = D1 ('MetaData "DescribeRecordResponse" "Amazonka.ServiceCatalog.DescribeRecord" "libZSservicesZSamazonka-servicecatalogZSamazonka-servicecatalog" 'False) (C1 ('MetaCons "DescribeRecordResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "recordDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RecordDetail)) :*: S1 ('MetaSel ('Just "nextPageToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recordOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RecordOutput])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeRecordResponse Source #

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:recordDetail:DescribeRecordResponse', describeRecordResponse_recordDetail - Information about the product.

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