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.MarketplaceCatalog.DescribeEntity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the metadata and content of the entity.

Synopsis

data DescribeEntity = DescribeEntity' {
- catalog :: Text
- entityId :: Text
}
newDescribeEntity :: Text -> Text -> DescribeEntity
describeEntity_catalog :: Lens' DescribeEntity Text
describeEntity_entityId :: Lens' DescribeEntity Text
data DescribeEntityResponse = DescribeEntityResponse' {
- details :: Maybe Text
- entityArn :: Maybe Text
- entityIdentifier :: Maybe Text
- entityType :: Maybe Text
- lastModifiedDate :: Maybe Text
- httpStatus :: Int
}
newDescribeEntityResponse :: Int -> DescribeEntityResponse
describeEntityResponse_details :: Lens' DescribeEntityResponse (Maybe Text)
describeEntityResponse_entityArn :: Lens' DescribeEntityResponse (Maybe Text)
describeEntityResponse_entityIdentifier :: Lens' DescribeEntityResponse (Maybe Text)
describeEntityResponse_entityType :: Lens' DescribeEntityResponse (Maybe Text)
describeEntityResponse_lastModifiedDate :: Lens' DescribeEntityResponse (Maybe Text)
describeEntityResponse_httpStatus :: Lens' DescribeEntityResponse Int

Creating a Request

data DescribeEntity Source #

See: newDescribeEntity smart constructor.

Constructors

DescribeEntity'
Fields catalog :: Text Required. The catalog related to the request. Fixed value: `AWSMarketplace` entityId :: Text Required. The unique ID of the entity to describe.

Instances

Instances details

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

newDescribeEntity Source #

Arguments

:: Text	`$sel:catalog:DescribeEntity'`
-> Text	`DescribeEntity`
-> DescribeEntity

Create a value of DescribeEntity 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:catalog:DescribeEntity', describeEntity_catalog - Required. The catalog related to the request. Fixed value: AWSMarketplace

DescribeEntity, describeEntity_entityId - Required. The unique ID of the entity to describe.

Request Lenses

describeEntity_catalog :: Lens' DescribeEntity Text Source #

Required. The catalog related to the request. Fixed value: AWSMarketplace

describeEntity_entityId :: Lens' DescribeEntity Text Source #

Required. The unique ID of the entity to describe.

Destructuring the Response

data DescribeEntityResponse Source #

See: newDescribeEntityResponse smart constructor.

Constructors

DescribeEntityResponse'

Fields

details :: Maybe Text
This stringified JSON object includes the details of the entity.
entityArn :: Maybe Text
The ARN associated to the unique identifier for the entity referenced in this request.
entityIdentifier :: Maybe Text
The identifier of the entity, in the format of EntityId@RevisionId.
entityType :: Maybe Text
The named type of the entity, in the format of EntityType@Version.
lastModifiedDate :: Maybe Text
The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeEntityResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.DescribeEntity Associated Types type Rep DescribeEntityResponse :: Type -> Type # Methods from :: DescribeEntityResponse -> Rep DescribeEntityResponse x # to :: Rep DescribeEntityResponse x -> DescribeEntityResponse #
Read DescribeEntityResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.DescribeEntity Methods readsPrec :: Int -> ReadS DescribeEntityResponse # readList :: ReadS [DescribeEntityResponse] # readPrec :: ReadPrec DescribeEntityResponse # readListPrec :: ReadPrec [DescribeEntityResponse] #
Show DescribeEntityResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.DescribeEntity Methods showsPrec :: Int -> DescribeEntityResponse -> ShowS # show :: DescribeEntityResponse -> String # showList :: [DescribeEntityResponse] -> ShowS #
NFData DescribeEntityResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.DescribeEntity Methods rnf :: DescribeEntityResponse -> () #
Eq DescribeEntityResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.DescribeEntity Methods (==) :: DescribeEntityResponse -> DescribeEntityResponse -> Bool # (/=) :: DescribeEntityResponse -> DescribeEntityResponse -> Bool #
type Rep DescribeEntityResponse Source #
Instance details Defined in Amazonka.MarketplaceCatalog.DescribeEntity type Rep DescribeEntityResponse = D1 ('MetaData "DescribeEntityResponse" "Amazonka.MarketplaceCatalog.DescribeEntity" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "DescribeEntityResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "entityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "entityIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "entityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeEntityResponse Source #

Arguments

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

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

DescribeEntityResponse, describeEntityResponse_details - This stringified JSON object includes the details of the entity.

DescribeEntityResponse, describeEntityResponse_entityArn - The ARN associated to the unique identifier for the entity referenced in this request.

$sel:entityIdentifier:DescribeEntityResponse', describeEntityResponse_entityIdentifier - The identifier of the entity, in the format of EntityId@RevisionId.

DescribeEntityResponse, describeEntityResponse_entityType - The named type of the entity, in the format of EntityType@Version.

DescribeEntityResponse, describeEntityResponse_lastModifiedDate - The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).

$sel:httpStatus:DescribeEntityResponse', describeEntityResponse_httpStatus - The response's http status code.

Response Lenses

describeEntityResponse_details :: Lens' DescribeEntityResponse (Maybe Text) Source #

This stringified JSON object includes the details of the entity.

describeEntityResponse_entityArn :: Lens' DescribeEntityResponse (Maybe Text) Source #

The ARN associated to the unique identifier for the entity referenced in this request.

describeEntityResponse_entityIdentifier :: Lens' DescribeEntityResponse (Maybe Text) Source #

The identifier of the entity, in the format of EntityId@RevisionId.

describeEntityResponse_entityType :: Lens' DescribeEntityResponse (Maybe Text) Source #

The named type of the entity, in the format of EntityType@Version.

describeEntityResponse_lastModifiedDate :: Lens' DescribeEntityResponse (Maybe Text) Source #

The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).

describeEntityResponse_httpStatus :: Lens' DescribeEntityResponse Int Source #

The response's http status code.