amazonka-servicecatalog-1.5.0: Amazon Service Catalog SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.ServiceCatalog.DescribeRecord

Contents

Description

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct , TerminateProvisionedProduct , or UpdateProvisionedProduct ).

Synopsis

Creating a Request

describeRecord Source #

Arguments

:: Text

drId

-> DescribeRecord 

Creates a value of DescribeRecord with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • drAcceptLanguage - The language code. * en - English (default) * jp - Japanese * zh - Chinese
  • drPageToken - The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .
  • drPageSize - The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.
  • drId - The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the RecordDetail.RecordId obtained from the request operation's response.

data DescribeRecord Source #

See: describeRecord smart constructor.

Instances

Eq DescribeRecord Source # 
Data DescribeRecord Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeRecord -> c DescribeRecord #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeRecord #

toConstr :: DescribeRecord -> Constr #

dataTypeOf :: DescribeRecord -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeRecord) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeRecord) #

gmapT :: (forall b. Data b => b -> b) -> DescribeRecord -> DescribeRecord #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeRecord -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeRecord -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeRecord -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeRecord -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeRecord -> m DescribeRecord #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeRecord -> m DescribeRecord #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeRecord -> m DescribeRecord #

Read DescribeRecord Source # 
Show DescribeRecord Source # 
Generic DescribeRecord Source # 

Associated Types

type Rep DescribeRecord :: * -> * #

Hashable DescribeRecord Source # 
ToJSON DescribeRecord Source # 
NFData DescribeRecord Source # 

Methods

rnf :: DescribeRecord -> () #

AWSRequest DescribeRecord Source # 
ToQuery DescribeRecord Source # 
ToPath DescribeRecord Source # 
ToHeaders DescribeRecord Source # 
type Rep DescribeRecord Source # 
type Rep DescribeRecord = D1 (MetaData "DescribeRecord" "Network.AWS.ServiceCatalog.DescribeRecord" "amazonka-servicecatalog-1.5.0-Gi5S0QNjzsJFyaLCAAAAWo" False) (C1 (MetaCons "DescribeRecord'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_drAcceptLanguage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_drPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_drPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_drId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeRecord Source # 

Request Lenses

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

The language code. * en - English (default) * jp - Japanese * zh - Chinese

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

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

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

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

drId :: Lens' DescribeRecord Text Source #

The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the RecordDetail.RecordId obtained from the request operation's response.

Destructuring the Response

describeRecordResponse Source #

Creates a value of DescribeRecordResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • drrsRecordDetail - Detailed record information for the specified product.
  • drrsNextPageToken - The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
  • drrsRecordOutputs - A list of outputs for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.
  • drrsResponseStatus - -- | The response status code.

data DescribeRecordResponse Source #

See: describeRecordResponse smart constructor.

Instances

Eq DescribeRecordResponse Source # 
Data DescribeRecordResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeRecordResponse -> c DescribeRecordResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeRecordResponse #

toConstr :: DescribeRecordResponse -> Constr #

dataTypeOf :: DescribeRecordResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeRecordResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeRecordResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeRecordResponse -> DescribeRecordResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeRecordResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeRecordResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeRecordResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeRecordResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeRecordResponse -> m DescribeRecordResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeRecordResponse -> m DescribeRecordResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeRecordResponse -> m DescribeRecordResponse #

Read DescribeRecordResponse Source # 
Show DescribeRecordResponse Source # 
Generic DescribeRecordResponse Source # 
NFData DescribeRecordResponse Source # 

Methods

rnf :: DescribeRecordResponse -> () #

type Rep DescribeRecordResponse Source # 
type Rep DescribeRecordResponse = D1 (MetaData "DescribeRecordResponse" "Network.AWS.ServiceCatalog.DescribeRecord" "amazonka-servicecatalog-1.5.0-Gi5S0QNjzsJFyaLCAAAAWo" False) (C1 (MetaCons "DescribeRecordResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_drrsRecordDetail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RecordDetail))) (S1 (MetaSel (Just Symbol "_drrsNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_drrsRecordOutputs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [RecordOutput]))) (S1 (MetaSel (Just Symbol "_drrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

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

Detailed record information for the specified product.

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

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

drrsRecordOutputs :: Lens' DescribeRecordResponse [RecordOutput] Source #

A list of outputs for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.

drrsResponseStatus :: Lens' DescribeRecordResponse Int Source #

  • - | The response status code.