| 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
Description
Derived from API version 2018-09-17 of the AWS service descriptions, licensed under Apache 2.0.
Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An entity can be a product or an offer on AWS Marketplace.
You can automate your entity update process by integrating the AWS Marketplace Catalog API with your AWS Marketplace product build or deployment pipelines. You can also create your own applications on top of the Catalog API to manage your products on AWS Marketplace.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _InternalServiceException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ResourceNotSupportedException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CancelChangeSet = CancelChangeSet' Text Text
- newCancelChangeSet :: Text -> Text -> CancelChangeSet
- data CancelChangeSetResponse = CancelChangeSetResponse' (Maybe Text) (Maybe Text) Int
- newCancelChangeSetResponse :: Int -> CancelChangeSetResponse
- data DescribeChangeSet = DescribeChangeSet' Text Text
- newDescribeChangeSet :: Text -> Text -> DescribeChangeSet
- data DescribeChangeSetResponse = DescribeChangeSetResponse' (Maybe [ChangeSummary]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FailureCode) (Maybe Text) (Maybe Text) (Maybe ChangeStatus) Int
- newDescribeChangeSetResponse :: Int -> DescribeChangeSetResponse
- data DescribeEntity = DescribeEntity' Text Text
- newDescribeEntity :: Text -> Text -> DescribeEntity
- data DescribeEntityResponse = DescribeEntityResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeEntityResponse :: Int -> DescribeEntityResponse
- data ListChangeSets = ListChangeSets' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Sort) Text
- newListChangeSets :: Text -> ListChangeSets
- data ListChangeSetsResponse = ListChangeSetsResponse' (Maybe [ChangeSetSummaryListItem]) (Maybe Text) Int
- newListChangeSetsResponse :: Int -> ListChangeSetsResponse
- data ListEntities = ListEntities' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Sort) Text Text
- newListEntities :: Text -> Text -> ListEntities
- data ListEntitiesResponse = ListEntitiesResponse' (Maybe [EntitySummary]) (Maybe Text) Int
- newListEntitiesResponse :: Int -> ListEntitiesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe Text) (Maybe (NonEmpty Tag)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StartChangeSet = StartChangeSet' (Maybe Text) (Maybe (NonEmpty Tag)) (Maybe Text) Text (NonEmpty Change)
- newStartChangeSet :: Text -> NonEmpty Change -> StartChangeSet
- data StartChangeSetResponse = StartChangeSetResponse' (Maybe Text) (Maybe Text) Int
- newStartChangeSetResponse :: Int -> StartChangeSetResponse
- data TagResource = TagResource' Text (NonEmpty Tag)
- newTagResource :: Text -> NonEmpty Tag -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- newtype ChangeStatus where
- ChangeStatus' { }
- pattern ChangeStatus_APPLYING :: ChangeStatus
- pattern ChangeStatus_CANCELLED :: ChangeStatus
- pattern ChangeStatus_FAILED :: ChangeStatus
- pattern ChangeStatus_PREPARING :: ChangeStatus
- pattern ChangeStatus_SUCCEEDED :: ChangeStatus
- newtype FailureCode where
- FailureCode' { }
- pattern FailureCode_CLIENT_ERROR :: FailureCode
- pattern FailureCode_SERVER_FAULT :: FailureCode
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASCENDING :: SortOrder
- pattern SortOrder_DESCENDING :: SortOrder
- data Change = Change' (Maybe Text) (Maybe (NonEmpty Tag)) Text Entity Text
- newChange :: Text -> Entity -> Text -> Change
- data ChangeSetSummaryListItem = ChangeSetSummaryListItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe FailureCode) (Maybe Text) (Maybe ChangeStatus)
- newChangeSetSummaryListItem :: ChangeSetSummaryListItem
- data ChangeSummary = ChangeSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Entity) (Maybe [ErrorDetail])
- newChangeSummary :: ChangeSummary
- data Entity = Entity' (Maybe Text) Text
- newEntity :: Text -> Entity
- data EntitySummary = EntitySummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEntitySummary :: EntitySummary
- data ErrorDetail = ErrorDetail' (Maybe Text) (Maybe Text)
- newErrorDetail :: ErrorDetail
- data Filter = Filter' (Maybe Text) (Maybe (NonEmpty Text))
- newFilter :: Filter
- data Sort = Sort' (Maybe Text) (Maybe SortOrder)
- newSort :: Sort
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2018-09-17 of the Amazon Marketplace Catalog Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by MarketplaceCatalog.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Access is denied.
InternalServiceException
_InternalServiceException :: AsError a => Fold a ServiceError Source #
There was an internal service exception.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The resource is currently in use.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource wasn't found.
ResourceNotSupportedException
_ResourceNotSupportedException :: AsError a => Fold a ServiceError Source #
Currently, the specified resource is not supported.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The maximum number of open requests per account has been exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
Too many requests.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
An error occurred during validation.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelChangeSet
data CancelChangeSet Source #
See: newCancelChangeSet smart constructor.
Constructors
| CancelChangeSet' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CancelChangeSet |
Create a value of CancelChangeSet 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:CancelChangeSet', cancelChangeSet_catalog - Required. The catalog related to the request. Fixed value:
AWSMarketplace.
CancelChangeSet, cancelChangeSet_changeSetId - Required. The unique identifier of the StartChangeSet request that you
want to cancel.
data CancelChangeSetResponse Source #
See: newCancelChangeSetResponse smart constructor.
Instances
newCancelChangeSetResponse Source #
Create a value of CancelChangeSetResponse 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:
CancelChangeSetResponse, cancelChangeSetResponse_changeSetArn - The ARN associated with the change set referenced in this request.
CancelChangeSet, cancelChangeSetResponse_changeSetId - The unique identifier for the change set referenced in this request.
$sel:httpStatus:CancelChangeSetResponse', cancelChangeSetResponse_httpStatus - The response's http status code.
DescribeChangeSet
data DescribeChangeSet Source #
See: newDescribeChangeSet smart constructor.
Constructors
| DescribeChangeSet' Text Text |
Instances
Create a value of DescribeChangeSet 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:DescribeChangeSet', describeChangeSet_catalog - Required. The catalog related to the request. Fixed value:
AWSMarketplace
DescribeChangeSet, describeChangeSet_changeSetId - Required. The unique identifier for the StartChangeSet request that
you want to describe the details for.
data DescribeChangeSetResponse Source #
See: newDescribeChangeSetResponse smart constructor.
Constructors
| DescribeChangeSetResponse' (Maybe [ChangeSummary]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe FailureCode) (Maybe Text) (Maybe Text) (Maybe ChangeStatus) Int |
Instances
newDescribeChangeSetResponse Source #
Create a value of DescribeChangeSetResponse 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:changeSet:DescribeChangeSetResponse', describeChangeSetResponse_changeSet - An array of ChangeSummary objects.
DescribeChangeSetResponse, describeChangeSetResponse_changeSetArn - The ARN associated with the unique identifier for the change set
referenced in this request.
DescribeChangeSet, describeChangeSetResponse_changeSetId - Required. The unique identifier for the change set referenced in this
request.
DescribeChangeSetResponse, describeChangeSetResponse_changeSetName - The optional name provided in the StartChangeSet request. If you do
not provide a name, one is set by default.
DescribeChangeSetResponse, describeChangeSetResponse_endTime - The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the
request transitioned to a terminal state. The change cannot transition
to a different state. Null if the request is not in a terminal state.
DescribeChangeSetResponse, describeChangeSetResponse_failureCode - Returned if the change set is in FAILED status. Can be either
CLIENT_ERROR, which means that there are issues with the request (see
the ErrorDetailList), or SERVER_FAULT, which means that there is a
problem in the system, and you should retry your request.
$sel:failureDescription:DescribeChangeSetResponse', describeChangeSetResponse_failureDescription - Returned if there is a failure on the change set, but that failure is
not related to any of the changes in the request.
DescribeChangeSetResponse, describeChangeSetResponse_startTime - The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the
request started.
DescribeChangeSetResponse, describeChangeSetResponse_status - The status of the change request.
$sel:httpStatus:DescribeChangeSetResponse', describeChangeSetResponse_httpStatus - The response's http status code.
DescribeEntity
data DescribeEntity Source #
See: newDescribeEntity smart constructor.
Constructors
| DescribeEntity' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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.
data DescribeEntityResponse Source #
See: newDescribeEntityResponse smart constructor.
Constructors
| DescribeEntityResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
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.
ListChangeSets
data ListChangeSets Source #
See: newListChangeSets smart constructor.
Constructors
| ListChangeSets' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Sort) Text |
Instances
Arguments
| :: Text | |
| -> ListChangeSets |
Create a value of ListChangeSets 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:filterList:ListChangeSets', listChangeSets_filterList - An array of filter objects.
$sel:maxResults:ListChangeSets', listChangeSets_maxResults - The maximum number of results returned by a single call. This value must
be provided in the next call to retrieve the next set of results. By
default, this value is 20.
ListChangeSets, listChangeSets_nextToken - The token value retrieved from a previous call to access the next page
of results.
$sel:sort:ListChangeSets', listChangeSets_sort - An object that contains two attributes, SortBy and SortOrder.
$sel:catalog:ListChangeSets', listChangeSets_catalog - The catalog related to the request. Fixed value: AWSMarketplace
data ListChangeSetsResponse Source #
See: newListChangeSetsResponse smart constructor.
Constructors
| ListChangeSetsResponse' (Maybe [ChangeSetSummaryListItem]) (Maybe Text) Int |
Instances
newListChangeSetsResponse Source #
Create a value of ListChangeSetsResponse 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:changeSetSummaryList:ListChangeSetsResponse', listChangeSetsResponse_changeSetSummaryList - Array of ChangeSetSummaryListItem objects.
ListChangeSets, listChangeSetsResponse_nextToken - The value of the next token, if it exists. Null if there are no more
results.
$sel:httpStatus:ListChangeSetsResponse', listChangeSetsResponse_httpStatus - The response's http status code.
ListEntities
data ListEntities Source #
See: newListEntities smart constructor.
Constructors
| ListEntities' (Maybe (NonEmpty Filter)) (Maybe Natural) (Maybe Text) (Maybe Sort) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListEntities |
Create a value of ListEntities 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:filterList:ListEntities', listEntities_filterList - An array of filter objects. Each filter object contains two attributes,
filterName and filterValues.
$sel:maxResults:ListEntities', listEntities_maxResults - Specifies the upper limit of the elements on a single page. If a value
isn't provided, the default value is 20.
ListEntities, listEntities_nextToken - The value of the next token, if it exists. Null if there are no more
results.
$sel:sort:ListEntities', listEntities_sort - An object that contains two attributes, SortBy and SortOrder.
$sel:catalog:ListEntities', listEntities_catalog - The catalog related to the request. Fixed value: AWSMarketplace
ListEntities, listEntities_entityType - The type of entities to retrieve.
data ListEntitiesResponse Source #
See: newListEntitiesResponse smart constructor.
Constructors
| ListEntitiesResponse' (Maybe [EntitySummary]) (Maybe Text) Int |
Instances
newListEntitiesResponse Source #
Arguments
| :: Int | |
| -> ListEntitiesResponse |
Create a value of ListEntitiesResponse 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:entitySummaryList:ListEntitiesResponse', listEntitiesResponse_entitySummaryList - Array of EntitySummary object.
ListEntities, listEntitiesResponse_nextToken - The value of the next token if it exists. Null if there is no more
result.
$sel:httpStatus:ListEntitiesResponse', listEntitiesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:
ListTagsForResource, listTagsForResource_resourceArn - Required. The Amazon Resource Name (ARN) associated with the resource
you want to list tags on.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:
ListTagsForResource, listTagsForResourceResponse_resourceArn - Required. The ARN associated with the resource you want to list tags on.
$sel:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Required. A list of objects specifying each key name and value. Number
of objects allowed: 1-50.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
StartChangeSet
data StartChangeSet Source #
See: newStartChangeSet smart constructor.
Instances
Arguments
| :: Text | |
| -> NonEmpty Change | |
| -> StartChangeSet |
Create a value of StartChangeSet 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:
StartChangeSet, startChangeSet_changeSetName - Optional case sensitive string of up to 100 ASCII characters. The change
set name can be used to filter the list of change sets.
$sel:changeSetTags:StartChangeSet', startChangeSet_changeSetTags - A list of objects specifying each key name and value for the
ChangeSetTags property.
$sel:clientRequestToken:StartChangeSet', startChangeSet_clientRequestToken - A unique token to identify the request to ensure idempotency.
$sel:catalog:StartChangeSet', startChangeSet_catalog - The catalog related to the request. Fixed value: AWSMarketplace
$sel:changeSet:StartChangeSet', startChangeSet_changeSet - Array of change object.
data StartChangeSetResponse Source #
See: newStartChangeSetResponse smart constructor.
Instances
newStartChangeSetResponse Source #
Create a value of StartChangeSetResponse 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:
StartChangeSetResponse, startChangeSetResponse_changeSetArn - The ARN associated to the unique identifier generated for the request.
StartChangeSetResponse, startChangeSetResponse_changeSetId - Unique identifier generated for the request.
$sel:httpStatus:StartChangeSetResponse', startChangeSetResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (NonEmpty Tag) |
Instances
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - Required. The Amazon Resource Name (ARN) associated with the resource
you want to tag.
$sel:tags:TagResource', tagResource_tags - Required. A list of objects specifying each key name and value. Number
of objects allowed: 1-50.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text (NonEmpty Text) |
Instances
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - Required. The Amazon Resource Name (ARN) associated with the resource
you want to remove the tag from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - Required. A list of key names of tags to be removed. Number of strings
allowed: 0-256.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
Types
ChangeStatus
newtype ChangeStatus Source #
Constructors
| ChangeStatus' | |
Fields | |
Bundled Patterns
| pattern ChangeStatus_APPLYING :: ChangeStatus | |
| pattern ChangeStatus_CANCELLED :: ChangeStatus | |
| pattern ChangeStatus_FAILED :: ChangeStatus | |
| pattern ChangeStatus_PREPARING :: ChangeStatus | |
| pattern ChangeStatus_SUCCEEDED :: ChangeStatus |
Instances
FailureCode
newtype FailureCode Source #
Constructors
| FailureCode' | |
Fields | |
Bundled Patterns
| pattern FailureCode_CLIENT_ERROR :: FailureCode | |
| pattern FailureCode_SERVER_FAULT :: FailureCode |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| pattern SortOrder_ASCENDING :: SortOrder | |
| pattern SortOrder_DESCENDING :: SortOrder |
Instances
Change
An object that contains the ChangeType, Details, and Entity.
See: newChange smart constructor.
Instances
Create a value of Change 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:changeName:Change', change_changeName - Optional name for the change.
$sel:entityTags:Change', change_entityTags - The tags associated with the change.
$sel:changeType:Change', change_changeType - Change types are single string values that describe your intention for
the change. Each change type is unique for each EntityType provided in
the change's scope.
$sel:entity:Change', change_entity - The entity to be changed.
$sel:details:Change', change_details - This object contains details specific to the change type of the
requested change.
ChangeSetSummaryListItem
data ChangeSetSummaryListItem Source #
A summary of a change set returned in a list of change sets when the
ListChangeSets action is called.
See: newChangeSetSummaryListItem smart constructor.
Constructors
| ChangeSetSummaryListItem' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe FailureCode) (Maybe Text) (Maybe ChangeStatus) |
Instances
newChangeSetSummaryListItem :: ChangeSetSummaryListItem Source #
Create a value of ChangeSetSummaryListItem 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:changeSetArn:ChangeSetSummaryListItem', changeSetSummaryListItem_changeSetArn - The ARN associated with the unique identifier for the change set
referenced in this request.
$sel:changeSetId:ChangeSetSummaryListItem', changeSetSummaryListItem_changeSetId - The unique identifier for a change set.
$sel:changeSetName:ChangeSetSummaryListItem', changeSetSummaryListItem_changeSetName - The non-unique name for the change set.
$sel:endTime:ChangeSetSummaryListItem', changeSetSummaryListItem_endTime - The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set
was finished.
$sel:entityIdList:ChangeSetSummaryListItem', changeSetSummaryListItem_entityIdList - This object is a list of entity IDs (string) that are a part of a change
set. The entity ID list is a maximum of 20 entities. It must contain at
least one entity.
$sel:failureCode:ChangeSetSummaryListItem', changeSetSummaryListItem_failureCode - Returned if the change set is in FAILED status. Can be either
CLIENT_ERROR, which means that there are issues with the request (see
the ErrorDetailList of DescribeChangeSet), or SERVER_FAULT, which
means that there is a problem in the system, and you should retry your
request.
$sel:startTime:ChangeSetSummaryListItem', changeSetSummaryListItem_startTime - The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set
was started.
$sel:status:ChangeSetSummaryListItem', changeSetSummaryListItem_status - The current status of the change set.
ChangeSummary
data ChangeSummary Source #
This object is a container for common summary information about the change. The summary doesn't contain the whole change structure.
See: newChangeSummary smart constructor.
Constructors
| ChangeSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Entity) (Maybe [ErrorDetail]) |
Instances
newChangeSummary :: ChangeSummary Source #
Create a value of ChangeSummary 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:changeName:ChangeSummary', changeSummary_changeName - Optional name for the change.
$sel:changeType:ChangeSummary', changeSummary_changeType - The type of the change.
$sel:details:ChangeSummary', changeSummary_details - This object contains details specific to the change type of the
requested change.
$sel:entity:ChangeSummary', changeSummary_entity - The entity to be changed.
$sel:errorDetailList:ChangeSummary', changeSummary_errorDetailList - An array of ErrorDetail objects associated with the change.
Entity
An entity contains data that describes your product, its supported features, and how it can be used or launched by your customer.
See: newEntity smart constructor.
Instances
| FromJSON Entity Source # | |
| ToJSON Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity | |
| Generic Entity Source # | |
| Read Entity Source # | |
| Show Entity Source # | |
| NFData Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity | |
| Eq Entity Source # | |
| Hashable Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity | |
| type Rep Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity type Rep Entity = D1 ('MetaData "Entity" "Amazonka.MarketplaceCatalog.Types.Entity" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "Entity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Entity 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:identifier:Entity', entity_identifier - The identifier for the entity.
$sel:type':Entity', entity_type - The type of entity.
EntitySummary
data EntitySummary Source #
This object is a container for common summary information about the entity. The summary doesn't contain the whole entity structure, but it does contain information common across all entities.
See: newEntitySummary smart constructor.
Constructors
| EntitySummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEntitySummary :: EntitySummary Source #
Create a value of EntitySummary 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:entityArn:EntitySummary', entitySummary_entityArn - The ARN associated with the unique identifier for the entity.
$sel:entityId:EntitySummary', entitySummary_entityId - The unique identifier for the entity.
$sel:entityType:EntitySummary', entitySummary_entityType - The type of the entity.
$sel:lastModifiedDate:EntitySummary', entitySummary_lastModifiedDate - The last time the entity was published, using ISO 8601 format
(2018-02-27T13:45:22Z).
$sel:name:EntitySummary', entitySummary_name - The name for the entity. This value is not unique. It is defined by the
seller.
$sel:visibility:EntitySummary', entitySummary_visibility - The visibility status of the entity to buyers. This value can be
Public (everyone can view the entity), Limited (the entity is
visible to limited accounts only), or Restricted (the entity was
published and then unpublished and only existing buyers can view it).
ErrorDetail
data ErrorDetail Source #
Details about the error.
See: newErrorDetail smart constructor.
Constructors
| ErrorDetail' (Maybe Text) (Maybe Text) |
Instances
newErrorDetail :: ErrorDetail Source #
Create a value of ErrorDetail 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:errorCode:ErrorDetail', errorDetail_errorCode - The error code that identifies the type of error.
$sel:errorMessage:ErrorDetail', errorDetail_errorMessage - The message for the error.
Filter
A filter object, used to optionally filter results from calls to the
ListEntities and ListChangeSets actions.
See: newFilter smart constructor.
Instances
| ToJSON Filter Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Filter | |
| Generic Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Filter | |
| Eq Filter Source # | |
| Hashable Filter Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Filter | |
| type Rep Filter Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.MarketplaceCatalog.Types.Filter" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "valueList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) | |
Create a value of Filter 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:name:Filter', filter_name - For ListEntities, the supported value for this is an EntityId.
For ListChangeSets, the supported values are as follows:
$sel:valueList:Filter', filter_valueList - ListEntities - This is a list of unique EntityIds.
ListChangeSets - The supported filter names and associated
ValueLists is as follows:
ChangeSetName- The supportedValueListis a list of non-uniqueChangeSetNames. These are defined when you call theStartChangeSetaction.Status- The supportedValueListis a list of statuses for all change set requests.EntityId- The supportedValueListis a list of uniqueEntityIds.BeforeStartTime- The supportedValueListis a list of all change sets that started before the filter value.AfterStartTime- The supportedValueListis a list of all change sets that started after the filter value.BeforeEndTime- The supportedValueListis a list of all change sets that ended before the filter value.AfterEndTime- The supportedValueListis a list of all change sets that ended after the filter value.
Sort
An object that contains two attributes, SortBy and SortOrder.
See: newSort smart constructor.
Instances
| ToJSON Sort Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Sort | |
| Generic Sort Source # | |
| Read Sort Source # | |
| Show Sort Source # | |
| NFData Sort Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Sort | |
| Eq Sort Source # | |
| Hashable Sort Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Sort | |
| type Rep Sort Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Sort type Rep Sort = D1 ('MetaData "Sort" "Amazonka.MarketplaceCatalog.Types.Sort" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "Sort'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)))) | |
Create a value of Sort 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:sortBy:Sort', sort_sortBy - For ListEntities, supported attributes include LastModifiedDate
(default), Visibility, EntityId, and Name.
For ListChangeSets, supported attributes include StartTime and
EndTime.
$sel:sortOrder:Sort', sort_sortOrder - The sorting order. Can be ASCENDING or DESCENDING. The default value
is DESCENDING.
Tag
A list of objects specifying each key name and value.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.MarketplaceCatalog.Types.Tag" "amazonka-marketplace-catalog-2.0-6Zi47AEGKrcHZeMO5lyES0" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - The key associated with the tag.
$sel:value:Tag', tag_value - The value associated with the tag.