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 |
Returns the metadata and content of the entity.
Synopsis
- data DescribeEntity = DescribeEntity' {}
- 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.
Instances
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.
DescribeEntityResponse' | |
|
Instances
newDescribeEntityResponse Source #
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.