Skip to content

Commit 64e8825

Browse files
author
AWS
committed
AWS Marketplace Catalog Service Update: The ListEntities API now supports the EntityID, LastModifiedDate, ProductTitle, and Visibility filters for machine learning products. You can also sort using all of those filters.
1 parent 1bd73d7 commit 64e8825

File tree

2 files changed

+188
-19
lines changed

2 files changed

+188
-19
lines changed

‎.changes/next-release/feature-AWSMarketplaceCatalogService-efe47fd.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Marketplace Catalog Service",
4+
"contributor": "",
5+
"description": "The ListEntities API now supports the EntityID, LastModifiedDate, ProductTitle, and Visibility filters for machine learning products. You can also sort using all of those filters."
6+
}

‎services/marketplacecatalog/src/main/resources/codegen-resources/service-2.json

Lines changed: 182 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@
55
"endpointPrefix":"catalog.marketplace",
66
"jsonVersion":"1.1",
77
"protocol":"rest-json",
8+
"protocols":["rest-json"],
89
"serviceAbbreviation":"AWS Marketplace Catalog",
910
"serviceFullName":"AWS Marketplace Catalog Service",
1011
"serviceId":"Marketplace Catalog",
1112
"signatureVersion":"v4",
1213
"signingName":"aws-marketplace",
13-
"uid":"marketplace-catalog-2018-09-17"
14+
"uid":"marketplace-catalog-2018-09-17",
15+
"auth":["aws.auth#sigv4"]
1416
},
1517
"operations":{
1618
"BatchDescribeEntities":{
@@ -200,7 +202,7 @@
200202
{"shape":"ThrottlingException"},
201203
{"shape":"ServiceQuotaExceededException"}
202204
],
203-
"documentation":"<p>Allows you to request changes for your entities. Within a single <code>ChangeSet</code>, you can't start the same change type against the same entity multiple times. Additionally, when a <code>ChangeSet</code> is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a <code>ResourceInUseException</code> error.</p> <p>For example, you can't start the <code>ChangeSet</code> described in the <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples\">example</a> later in this topic because it contains two changes to run the same change type (<code>AddRevisions</code>) against the same entity (<code>entity-id@1</code>).</p> <p>For more information about working with change sets, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\"> Working with change sets</a>. For information about change types for single-AMI products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products\">Working with single-AMI products</a>. Also, for more information about change types available for container-based products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products\">Working with container products</a>.</p>"
205+
"documentation":"<p>Allows you to request changes for your entities. Within a single <code>ChangeSet</code>, you can't start the same change type against the same entity multiple times. Additionally, when a <code>ChangeSet</code> is running, all the entities targeted by the different changes are locked until the change set has completed (either succeeded, cancelled, or failed). If you try to start a change set containing a change against an entity that is already locked, you will receive a <code>ResourceInUseException</code> error.</p> <p>For example, you can't start the <code>ChangeSet</code> described in the <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_Examples\">example</a> later in this topic because it contains two changes to run the same change type (<code>AddRevisions</code>) against the same entity (<code>entity-id@1</code>).</p> <p>For more information about working with change sets, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/welcome.html#working-with-change-sets\"> Working with change sets</a>. For information about change types for single-AMI products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products\">Working with single-AMI products</a>. Also, for more information about change types available for container-based products, see <a href=\"https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products\">Working with container products</a>.</p> <p>To download \"DetailsDocument\" shapes, see <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-python\">Python</a> and <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-java/tree/main\">Java</a> shapes on GitHub.</p>"
204206
},
205207
"TagResource":{
206208
"name":"TagResource",
@@ -524,7 +526,7 @@
524526
},
525527
"DetailsDocument":{
526528
"shape":"JsonDocumentType",
527-
"documentation":"<p>Alternative field that accepts a JSON value instead of a string for <code>ChangeType</code> details. You can use either <code>Details</code> or <code>DetailsDocument</code>, but not both.</p>"
529+
"documentation":"<p>Alternative field that accepts a JSON value instead of a string for <code>ChangeType</code> details. You can use either <code>Details</code> or <code>DetailsDocument</code>, but not both.</p> <p>To download the \"DetailsDocument\" shapes, see the <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-python\">Python</a> and <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-java/tree/main\">Java</a> shapes on GitHub.</p>"
528530
},
529531
"ChangeName":{
530532
"shape":"ChangeName",
@@ -618,7 +620,7 @@
618620
},
619621
"DetailsDocument":{
620622
"shape":"JsonDocumentType",
621-
"documentation":"<p>The JSON value of the details specific to the change type of the requested change.</p>"
623+
"documentation":"<p>The JSON value of the details specific to the change type of the requested change.</p> <p>To download the \"DetailsDocument\" shapes, see the <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-python\">Python</a> and <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-java/tree/main\">Java</a> shapes on GitHub.</p>"
622624
},
623625
"ErrorDetailList":{
624626
"shape":"ErrorDetailList",
@@ -976,8 +978,7 @@
976978
},
977979
"DeleteResourcePolicyResponse":{
978980
"type":"structure",
979-
"members":{
980-
}
981+
"members":{}
981982
},
982983
"DescribeChangeSetRequest":{
983984
"type":"structure",
@@ -1091,7 +1092,7 @@
10911092
},
10921093
"DetailsDocument":{
10931094
"shape":"JsonDocumentType",
1094-
"documentation":"<p>The JSON value of the details specific to the entity.</p>"
1095+
"documentation":"<p>The JSON value of the details specific to the entity.</p> <p>To download \"DetailsDocument\" shapes, see the <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-python\">Python</a> and <a href=\"https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-java/tree/main\">Java</a> shapes on GitHub.</p>"
10951096
}
10961097
}
10971098
},
@@ -1227,7 +1228,8 @@
12271228
"ResaleAuthorizationSummary":{
12281229
"shape":"ResaleAuthorizationSummary",
12291230
"documentation":"<p>An object that contains summary information about the Resale Authorization.</p>"
1230-
}
1231+
},
1232+
"MachineLearningProductSummary":{"shape":"MachineLearningProductSummary"}
12311233
},
12321234
"documentation":"<p>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.</p>"
12331235
},
@@ -1267,7 +1269,8 @@
12671269
"ResaleAuthorizationFilters":{
12681270
"shape":"ResaleAuthorizationFilters",
12691271
"documentation":"<p>A filter for Resale Authorizations.</p>"
1270-
}
1272+
},
1273+
"MachineLearningProductFilters":{"shape":"MachineLearningProductFilters"}
12711274
},
12721275
"documentation":"<p>Object containing all the filter fields per entity type.</p>",
12731276
"union":true
@@ -1298,7 +1301,8 @@
12981301
"ResaleAuthorizationSort":{
12991302
"shape":"ResaleAuthorizationSort",
13001303
"documentation":"<p>A sort for Resale Authorizations.</p>"
1301-
}
1304+
},
1305+
"MachineLearningProductSort":{"shape":"MachineLearningProductSort"}
13021306
},
13031307
"documentation":"<p>Object containing all the sort fields per entity type.</p>",
13041308
"union":true
@@ -1429,8 +1433,7 @@
14291433
},
14301434
"JsonDocumentType":{
14311435
"type":"structure",
1432-
"members":{
1433-
},
1436+
"members":{},
14341437
"document":true
14351438
},
14361439
"ListChangeSetsMaxResultInteger":{
@@ -1565,6 +1568,169 @@
15651568
}
15661569
}
15671570
},
1571+
"MachineLearningProductEntityIdFilter":{
1572+
"type":"structure",
1573+
"members":{
1574+
"ValueList":{
1575+
"shape":"MachineLearningProductEntityIdFilterValueList",
1576+
"documentation":"<p>A list of entity IDs to filter by. The operation returns machine learning products with entity IDs that match the values in this list.</p>"
1577+
}
1578+
},
1579+
"documentation":"<p>The filter for machine learning product entity IDs.</p>"
1580+
},
1581+
"MachineLearningProductEntityIdFilterValueList":{
1582+
"type":"list",
1583+
"member":{"shape":"MachineLearningProductEntityIdString"},
1584+
"documentation":"<p>A list of entity ID values to filter by. You can include up to 10 entity IDs in this list.</p>",
1585+
"max":10,
1586+
"min":1
1587+
},
1588+
"MachineLearningProductEntityIdString":{
1589+
"type":"string",
1590+
"documentation":"<p>The entity ID of a machine learning product. This string uniquely identifies the product.</p>",
1591+
"max":255,
1592+
"min":1,
1593+
"pattern":"^[a-zA-Z0-9][.a-zA-Z0-9/-]+[a-zA-Z0-9]$"
1594+
},
1595+
"MachineLearningProductFilters":{
1596+
"type":"structure",
1597+
"members":{
1598+
"EntityId":{
1599+
"shape":"MachineLearningProductEntityIdFilter",
1600+
"documentation":"<p>Filter machine learning products by their entity IDs.</p>"
1601+
},
1602+
"LastModifiedDate":{
1603+
"shape":"MachineLearningProductLastModifiedDateFilter",
1604+
"documentation":"<p>Filter machine learning products by their last modified date.</p>"
1605+
},
1606+
"ProductTitle":{
1607+
"shape":"MachineLearningProductTitleFilter",
1608+
"documentation":"<p>Filter machine learning products by their product titles.</p>"
1609+
},
1610+
"Visibility":{
1611+
"shape":"MachineLearningProductVisibilityFilter",
1612+
"documentation":"<p>Filter machine learning products by their visibility status.</p>"
1613+
}
1614+
},
1615+
"documentation":"<p>The filters that you can use with the ListEntities operation to filter machine learning products. You can filter by EntityId, LastModifiedDate, ProductTitle, and Visibility.</p>"
1616+
},
1617+
"MachineLearningProductLastModifiedDateFilter":{
1618+
"type":"structure",
1619+
"members":{
1620+
"DateRange":{
1621+
"shape":"MachineLearningProductLastModifiedDateFilterDateRange",
1622+
"documentation":"<p>A date range to filter by. The operation returns machine learning products with last modified dates that fall within this range.</p>"
1623+
}
1624+
},
1625+
"documentation":"<p>The filter for machine learning product last modified date.</p>"
1626+
},
1627+
"MachineLearningProductLastModifiedDateFilterDateRange":{
1628+
"type":"structure",
1629+
"members":{
1630+
"AfterValue":{
1631+
"shape":"DateTimeISO8601",
1632+
"documentation":"<p>The start date (inclusive) of the date range. The operation returns machine learning products with last modified dates on or after this date.</p>"
1633+
},
1634+
"BeforeValue":{
1635+
"shape":"DateTimeISO8601",
1636+
"documentation":"<p>The end date (inclusive) of the date range. The operation returns machine learning products with last modified dates on or before this date.</p>"
1637+
}
1638+
},
1639+
"documentation":"<p>A date range for filtering machine learning products by their last modified date.</p>"
1640+
},
1641+
"MachineLearningProductSort":{
1642+
"type":"structure",
1643+
"members":{
1644+
"SortBy":{
1645+
"shape":"MachineLearningProductSortBy",
1646+
"documentation":"<p>The field to sort by. Valid values: <code>EntityId</code>, <code>LastModifiedDate</code>, <code>ProductTitle</code>, and <code>Visibility</code>.</p>"
1647+
},
1648+
"SortOrder":{
1649+
"shape":"SortOrder",
1650+
"documentation":"<p>The sort order. Valid values are <code>ASC</code> (ascending) and <code>DESC</code> (descending).</p>"
1651+
}
1652+
},
1653+
"documentation":"<p>The sort options for machine learning products.</p>"
1654+
},
1655+
"MachineLearningProductSortBy":{
1656+
"type":"string",
1657+
"documentation":"<p>The fields that you can sort machine learning products by.</p>",
1658+
"enum":[
1659+
"EntityId",
1660+
"LastModifiedDate",
1661+
"ProductTitle",
1662+
"Visibility"
1663+
]
1664+
},
1665+
"MachineLearningProductSummary":{
1666+
"type":"structure",
1667+
"members":{
1668+
"ProductTitle":{
1669+
"shape":"MachineLearningProductTitleString",
1670+
"documentation":"<p>The title of the machine learning product.</p>"
1671+
},
1672+
"Visibility":{
1673+
"shape":"MachineLearningProductVisibilityString",
1674+
"documentation":"<p>The visibility status of the machine learning product. Valid values are <code>Limited</code>, <code>Public</code>, <code>Restricted</code>, and <code>Draft</code>.</p>"
1675+
}
1676+
},
1677+
"documentation":"<p>A summary of a machine learning product.</p>"
1678+
},
1679+
"MachineLearningProductTitleFilter":{
1680+
"type":"structure",
1681+
"members":{
1682+
"ValueList":{
1683+
"shape":"MachineLearningProductTitleFilterValueList",
1684+
"documentation":"<p>A list of product titles to filter by. The operation returns machine learning products with titles that exactly match the values in this list.</p>"
1685+
},
1686+
"WildCardValue":{
1687+
"shape":"MachineLearningProductTitleString",
1688+
"documentation":"<p>A wildcard value to filter product titles. The operation returns machine learning products with titles that match this wildcard pattern.</p>"
1689+
}
1690+
},
1691+
"documentation":"<p>The filter for machine learning product titles.</p>"
1692+
},
1693+
"MachineLearningProductTitleFilterValueList":{
1694+
"type":"list",
1695+
"member":{"shape":"MachineLearningProductTitleString"},
1696+
"documentation":"<p>A list of product title values to filter by. You can include up to 10 product titles in this list.</p>",
1697+
"max":10,
1698+
"min":1
1699+
},
1700+
"MachineLearningProductTitleString":{
1701+
"type":"string",
1702+
"documentation":"<p>The title of a machine learning product.</p>",
1703+
"max":255,
1704+
"min":1,
1705+
"pattern":"^(.)+$"
1706+
},
1707+
"MachineLearningProductVisibilityFilter":{
1708+
"type":"structure",
1709+
"members":{
1710+
"ValueList":{
1711+
"shape":"MachineLearningProductVisibilityFilterValueList",
1712+
"documentation":"<p>A list of visibility values to filter by. The operation returns machine learning products with visibility status that match the values in this list.</p>"
1713+
}
1714+
},
1715+
"documentation":"<p>The filter for machine learning product visibility status.</p>"
1716+
},
1717+
"MachineLearningProductVisibilityFilterValueList":{
1718+
"type":"list",
1719+
"member":{"shape":"MachineLearningProductVisibilityString"},
1720+
"documentation":"<p>A list of visibility status values to filter by. You can include up to 10 visibility status values in this list.</p>",
1721+
"max":10,
1722+
"min":1
1723+
},
1724+
"MachineLearningProductVisibilityString":{
1725+
"type":"string",
1726+
"documentation":"<p>The visibility status of a machine learning product. Valid values are:</p> <ul> <li> <p> <code>Limited</code> - The product is available to a limited set of buyers.</p> </li> <li> <p> <code>Public</code> - The product is publicly available to all buyers.</p> </li> <li> <p> <code>Restricted</code> - The product has restricted availability.</p> </li> <li> <p> <code>Draft</code> - The product is in draft state and not yet available to buyers.</p> </li> </ul>",
1727+
"enum":[
1728+
"Limited",
1729+
"Public",
1730+
"Restricted",
1731+
"Draft"
1732+
]
1733+
},
15681734
"NextToken":{
15691735
"type":"string",
15701736
"max":2048,
@@ -1956,8 +2122,7 @@
19562122
},
19572123
"PutResourcePolicyResponse":{
19582124
"type":"structure",
1959-
"members":{
1960-
}
2125+
"members":{}
19612126
},
19622127
"RequestedChangeList":{
19632128
"type":"list",
@@ -2836,8 +3001,7 @@
28363001
},
28373002
"TagResourceResponse":{
28383003
"type":"structure",
2839-
"members":{
2840-
}
3004+
"members":{}
28413005
},
28423006
"TagValue":{
28433007
"type":"string",
@@ -2874,8 +3038,7 @@
28743038
},
28753039
"UntagResourceResponse":{
28763040
"type":"structure",
2877-
"members":{
2878-
}
3041+
"members":{}
28793042
},
28803043
"ValidationException":{
28813044
"type":"structure",
@@ -2900,5 +3063,5 @@
29003063
"pattern":"^[a-zA-Z]+$"
29013064
}
29023065
},
2903-
"documentation":"<p>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. </p> <p>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.</p>"
3066+
"documentation":"<p>Catalog API actions allow you to manage your entities through list, describe, and update capabilities. An <i>entity</i> can be a product or an offer on AWS Marketplace. </p> <p>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.</p>"
29043067
}

0 commit comments

Comments
 (0)