Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- 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' {
- changeName :: Maybe Text
- changeType :: Text
- entity :: Entity
- details :: Text
- newChange :: Text -> Entity -> Text -> Change
- change_changeName :: Lens' Change (Maybe Text)
- change_changeType :: Lens' Change Text
- change_entity :: Lens' Change Entity
- change_details :: Lens' Change Text
- data ChangeSetSummaryListItem = ChangeSetSummaryListItem' {
- status :: Maybe ChangeStatus
- entityIdList :: Maybe [Text]
- startTime :: Maybe Text
- failureCode :: Maybe FailureCode
- changeSetName :: Maybe Text
- changeSetId :: Maybe Text
- endTime :: Maybe Text
- changeSetArn :: Maybe Text
- newChangeSetSummaryListItem :: ChangeSetSummaryListItem
- changeSetSummaryListItem_status :: Lens' ChangeSetSummaryListItem (Maybe ChangeStatus)
- changeSetSummaryListItem_entityIdList :: Lens' ChangeSetSummaryListItem (Maybe [Text])
- changeSetSummaryListItem_startTime :: Lens' ChangeSetSummaryListItem (Maybe Text)
- changeSetSummaryListItem_failureCode :: Lens' ChangeSetSummaryListItem (Maybe FailureCode)
- changeSetSummaryListItem_changeSetName :: Lens' ChangeSetSummaryListItem (Maybe Text)
- changeSetSummaryListItem_changeSetId :: Lens' ChangeSetSummaryListItem (Maybe Text)
- changeSetSummaryListItem_endTime :: Lens' ChangeSetSummaryListItem (Maybe Text)
- changeSetSummaryListItem_changeSetArn :: Lens' ChangeSetSummaryListItem (Maybe Text)
- data ChangeSummary = ChangeSummary' {
- changeName :: Maybe Text
- details :: Maybe Text
- errorDetailList :: Maybe [ErrorDetail]
- entity :: Maybe Entity
- changeType :: Maybe Text
- newChangeSummary :: ChangeSummary
- changeSummary_changeName :: Lens' ChangeSummary (Maybe Text)
- changeSummary_details :: Lens' ChangeSummary (Maybe Text)
- changeSummary_errorDetailList :: Lens' ChangeSummary (Maybe [ErrorDetail])
- changeSummary_entity :: Lens' ChangeSummary (Maybe Entity)
- changeSummary_changeType :: Lens' ChangeSummary (Maybe Text)
- data Entity = Entity' {
- identifier :: Maybe Text
- type' :: Text
- newEntity :: Text -> Entity
- entity_identifier :: Lens' Entity (Maybe Text)
- entity_type :: Lens' Entity Text
- data EntitySummary = EntitySummary' {}
- newEntitySummary :: EntitySummary
- entitySummary_lastModifiedDate :: Lens' EntitySummary (Maybe Text)
- entitySummary_entityType :: Lens' EntitySummary (Maybe Text)
- entitySummary_visibility :: Lens' EntitySummary (Maybe Text)
- entitySummary_name :: Lens' EntitySummary (Maybe Text)
- entitySummary_entityId :: Lens' EntitySummary (Maybe Text)
- entitySummary_entityArn :: Lens' EntitySummary (Maybe Text)
- data ErrorDetail = ErrorDetail' {}
- newErrorDetail :: ErrorDetail
- errorDetail_errorCode :: Lens' ErrorDetail (Maybe Text)
- errorDetail_errorMessage :: Lens' ErrorDetail (Maybe Text)
- data Filter = Filter' {}
- newFilter :: Filter
- filter_valueList :: Lens' Filter (Maybe (NonEmpty Text))
- filter_name :: Lens' Filter (Maybe Text)
- data Sort = Sort' {}
- newSort :: Sort
- sort_sortOrder :: Lens' Sort (Maybe SortOrder)
- sort_sortBy :: Lens' Sort (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2018-09-17
of the Amazon Marketplace Catalog Service SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred during validation.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Access is denied.
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The maximum number of open requests per account has been exceeded.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Too many requests.
_InternalServiceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was an internal service exception.
_ResourceNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Currently, the specified resource is not supported.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource wasn't found.
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource is currently in use.
ChangeStatus
newtype ChangeStatus Source #
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 #
pattern FailureCode_CLIENT_ERROR :: FailureCode | |
pattern FailureCode_SERVER_FAULT :: FailureCode |
Instances
SortOrder
pattern SortOrder_ASCENDING :: SortOrder | |
pattern SortOrder_DESCENDING :: SortOrder |
Instances
Change
An object that contains the ChangeType
, Details
, and Entity
.
See: newChange
smart constructor.
Change' | |
|
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: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.
change_changeType :: Lens' Change Text Source #
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.
change_details :: Lens' Change Text Source #
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.
ChangeSetSummaryListItem' | |
|
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:status:ChangeSetSummaryListItem'
, changeSetSummaryListItem_status
- The current status of the change set.
$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:startTime:ChangeSetSummaryListItem'
, changeSetSummaryListItem_startTime
- The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set
was started.
$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:changeSetName:ChangeSetSummaryListItem'
, changeSetSummaryListItem_changeSetName
- The non-unique name for the change set.
$sel:changeSetId:ChangeSetSummaryListItem'
, changeSetSummaryListItem_changeSetId
- The unique identifier for a 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:changeSetArn:ChangeSetSummaryListItem'
, changeSetSummaryListItem_changeSetArn
- The ARN associated with the unique identifier for the change set
referenced in this request.
changeSetSummaryListItem_status :: Lens' ChangeSetSummaryListItem (Maybe ChangeStatus) Source #
The current status of the change set.
changeSetSummaryListItem_entityIdList :: Lens' ChangeSetSummaryListItem (Maybe [Text]) Source #
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.
changeSetSummaryListItem_startTime :: Lens' ChangeSetSummaryListItem (Maybe Text) Source #
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
changeSetSummaryListItem_failureCode :: Lens' ChangeSetSummaryListItem (Maybe FailureCode) Source #
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.
changeSetSummaryListItem_changeSetName :: Lens' ChangeSetSummaryListItem (Maybe Text) Source #
The non-unique name for the change set.
changeSetSummaryListItem_changeSetId :: Lens' ChangeSetSummaryListItem (Maybe Text) Source #
The unique identifier for a change set.
changeSetSummaryListItem_endTime :: Lens' ChangeSetSummaryListItem (Maybe Text) Source #
The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
changeSetSummaryListItem_changeSetArn :: Lens' ChangeSetSummaryListItem (Maybe Text) Source #
The ARN associated with the unique identifier for the change set referenced in this request.
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.
ChangeSummary' | |
|
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:details:ChangeSummary'
, changeSummary_details
- This object contains details specific to the change type of the
requested change.
$sel:errorDetailList:ChangeSummary'
, changeSummary_errorDetailList
- An array of ErrorDetail
objects associated with the change.
$sel:entity:ChangeSummary'
, changeSummary_entity
- The entity to be changed.
$sel:changeType:ChangeSummary'
, changeSummary_changeType
- The type of the change.
changeSummary_changeName :: Lens' ChangeSummary (Maybe Text) Source #
Optional name for the change.
changeSummary_details :: Lens' ChangeSummary (Maybe Text) Source #
This object contains details specific to the change type of the requested change.
changeSummary_errorDetailList :: Lens' ChangeSummary (Maybe [ErrorDetail]) Source #
An array of ErrorDetail
objects associated with the change.
changeSummary_entity :: Lens' ChangeSummary (Maybe Entity) Source #
The entity to be changed.
changeSummary_changeType :: Lens' ChangeSummary (Maybe Text) Source #
The type of 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
Eq Entity Source # | |
Read Entity Source # | |
Show Entity Source # | |
Generic Entity Source # | |
NFData Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity | |
Hashable Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity | |
ToJSON Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity | |
FromJSON Entity Source # | |
type Rep Entity Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Entity type Rep Entity = D1 ('MetaData "Entity" "Amazonka.MarketplaceCatalog.Types.Entity" "libZSservicesZSamazonka-marketplace-catalogZSamazonka-marketplace-catalog" '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.
EntitySummary' | |
|
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:lastModifiedDate:EntitySummary'
, entitySummary_lastModifiedDate
- The last time the entity was published, using ISO 8601 format
(2018-02-27T13:45:22Z).
$sel:entityType:EntitySummary'
, entitySummary_entityType
- The type of the entity.
$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).
$sel:name:EntitySummary'
, entitySummary_name
- The name for the entity. This value is not unique. It is defined by the
seller.
$sel:entityId:EntitySummary'
, entitySummary_entityId
- The unique identifier for the entity.
$sel:entityArn:EntitySummary'
, entitySummary_entityArn
- The ARN associated with the unique identifier for the entity.
entitySummary_lastModifiedDate :: Lens' EntitySummary (Maybe Text) Source #
The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
entitySummary_entityType :: Lens' EntitySummary (Maybe Text) Source #
The type of the entity.
entitySummary_visibility :: Lens' EntitySummary (Maybe Text) Source #
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).
entitySummary_name :: Lens' EntitySummary (Maybe Text) Source #
The name for the entity. This value is not unique. It is defined by the seller.
entitySummary_entityId :: Lens' EntitySummary (Maybe Text) Source #
The unique identifier for the entity.
entitySummary_entityArn :: Lens' EntitySummary (Maybe Text) Source #
The ARN associated with the unique identifier for the entity.
ErrorDetail
data ErrorDetail Source #
Details about the error.
See: newErrorDetail
smart constructor.
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.
errorDetail_errorCode :: Lens' ErrorDetail (Maybe Text) Source #
The error code that identifies the type of error.
errorDetail_errorMessage :: Lens' ErrorDetail (Maybe Text) Source #
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.
Filter' | |
|
Instances
Eq Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
Generic Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Filter | |
Hashable Filter Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Filter | |
ToJSON 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" "libZSservicesZSamazonka-marketplace-catalogZSamazonka-marketplace-catalog" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "valueList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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:valueList:Filter'
, filter_valueList
- ListEntities
- This is a list of unique EntityId
s.
ListChangeSets
- The supported filter names and associated
ValueList
s is as follows:
ChangeSetName
- The supportedValueList
is a list of non-uniqueChangeSetName
s. These are defined when you call theStartChangeSet
action.Status
- The supportedValueList
is a list of statuses for all change set requests.EntityId
- The supportedValueList
is a list of uniqueEntityId
s.BeforeStartTime
- The supportedValueList
is a list of all change sets that started before the filter value.AfterStartTime
- The supportedValueList
is a list of all change sets that started after the filter value.BeforeEndTime
- The supportedValueList
is a list of all change sets that ended before the filter value.AfterEndTime
- The supportedValueList
is a list of all change sets that ended after the filter value.
$sel:name:Filter'
, filter_name
- For ListEntities
, the supported value for this is an EntityId
.
For ListChangeSets
, the supported values are as follows:
filter_valueList :: Lens' Filter (Maybe (NonEmpty Text)) Source #
ListEntities
- This is a list of unique EntityId
s.
ListChangeSets
- The supported filter names and associated
ValueList
s is as follows:
ChangeSetName
- The supportedValueList
is a list of non-uniqueChangeSetName
s. These are defined when you call theStartChangeSet
action.Status
- The supportedValueList
is a list of statuses for all change set requests.EntityId
- The supportedValueList
is a list of uniqueEntityId
s.BeforeStartTime
- The supportedValueList
is a list of all change sets that started before the filter value.AfterStartTime
- The supportedValueList
is a list of all change sets that started after the filter value.BeforeEndTime
- The supportedValueList
is a list of all change sets that ended before the filter value.AfterEndTime
- The supportedValueList
is a list of all change sets that ended after the filter value.
filter_name :: Lens' Filter (Maybe Text) Source #
For ListEntities
, the supported value for this is an EntityId
.
For ListChangeSets
, the supported values are as follows:
Sort
An object that contains two attributes, SortBy
and SortOrder
.
See: newSort
smart constructor.
Sort' | |
|
Instances
Eq Sort Source # | |
Read Sort Source # | |
Show Sort Source # | |
Generic Sort Source # | |
NFData Sort Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Sort | |
Hashable Sort Source # | |
Defined in Amazonka.MarketplaceCatalog.Types.Sort | |
ToJSON 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" "libZSservicesZSamazonka-marketplace-catalogZSamazonka-marketplace-catalog" 'False) (C1 ('MetaCons "Sort'" 'PrefixI 'True) (S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
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:sortOrder:Sort'
, sort_sortOrder
- The sorting order. Can be ASCENDING
or DESCENDING
. The default value
is DESCENDING
.
$sel:sortBy:Sort'
, sort_sortBy
- For ListEntities
, supported attributes include LastModifiedDate
(default), Visibility
, EntityId
, and Name
.
For ListChangeSets
, supported attributes include StartTime
and
EndTime
.