2021/11/29 - Amazon Personalize - 8 new 7 updated api methods
Changes This release adds API support for Recommenders and BatchSegmentJobs.
Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see recommendations-batch.
See also: AWS API Documentation
Request Syntax
client.create_batch_segment_job(
jobName='string',
solutionVersionArn='string',
filterArn='string',
numResults=123,
jobInput={
's3DataSource': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
jobOutput={
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
roleArn='string'
)
string
[REQUIRED]
The name of the batch segment job to create.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.
string
The ARN of the filter to apply to the batch segment job. For more information on using filters, see filter-batch.
integer
The number of predicted users generated by the batch segment job for each line of input data.
dict
[REQUIRED]
The Amazon S3 path for the input data used to generate the batch segment job.
s3DataSource (dict) -- [REQUIRED]
The configuration details of an Amazon S3 input or output bucket.
path (string) -- [REQUIRED]
The file path of the Amazon S3 bucket.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
dict
[REQUIRED]
The Amazon S3 path for the bucket where the job's output will be stored.
s3DataDestination (dict) -- [REQUIRED]
The configuration details of an Amazon S3 input or output bucket.
path (string) -- [REQUIRED]
The file path of the Amazon S3 bucket.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
string
[REQUIRED]
The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.
dict
Response Syntax
{
'batchSegmentJobArn': 'string'
}
Response Structure
(dict) --
batchSegmentJobArn (string) --
The ARN of the batch segment job.
Returns a list of recommenders in a given Domain dataset group. When a Domain dataset group is not specified, all the recommenders associated with the account are listed. The response provides the properties for each recommender, including the Amazon Resource Name (ARN). For more information on recommenders, see CreateRecommender.
See also: AWS API Documentation
Request Syntax
client.list_recommenders(
datasetGroupArn='string',
nextToken='string',
maxResults=123
)
string
The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When a Domain dataset group is not specified, all the recommenders associated with the account are listed.
string
A token returned from the previous call to ListRecommenders for getting the next set of recommenders (if they exist).
integer
The maximum number of recommenders to return.
dict
Response Syntax
{
'recommenders': [
{
'name': 'string',
'recommenderArn': 'string',
'datasetGroupArn': 'string',
'recipeArn': 'string',
'recommenderConfig': {
'itemExplorationConfig': {
'string': 'string'
}
},
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
recommenders (list) --
A list of the recommenders.
(dict) --
Provides a summary of the properties of the recommender.
name (string) --
The name of the recommender.
recommenderArn (string) --
The Amazon Resource Name (ARN) of the recommender.
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
recommenderConfig (dict) --
The configuration details of the recommender.
itemExplorationConfig (dict) --
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
(string) --
(string) --
status (string) --
The status of the recommender. A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
creationDateTime (datetime) --
The date and time (in Unix format) that the recommender was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix format) that the recommender was last updated.
nextToken (string) --
A token for getting the next set of recommenders (if they exist).
Deactivates and removes a recommender. A deleted recommender can no longer be specified in a GetRecommendations request.
See also: AWS API Documentation
Request Syntax
client.delete_recommender(
recommenderArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to delete.
None
Updates the recommender to modify the recommender configuration.
See also: AWS API Documentation
Request Syntax
client.update_recommender(
recommenderArn='string',
recommenderConfig={
'itemExplorationConfig': {
'string': 'string'
}
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to modify.
dict
[REQUIRED]
The configuration details of the recommender.
itemExplorationConfig (dict) --
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
(string) --
(string) --
dict
Response Syntax
{
'recommenderArn': 'string'
}
Response Structure
(dict) --
recommenderArn (string) --
The same recommender Amazon Resource Name (ARN) as given in the request.
Creates a recommender with the recipe (a Domain dataset group use case) you specify. You create recommenders for a Domain dataset group and specify the recommender's Amazon Resource Name (ARN) when you make a GetRecommendations request.
Status
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
To get the recommender status, call DescribeRecommender.
Note
Wait until the status of the recommender is ACTIVE before asking the recommender for recommendations.
Related APIs
ListRecommenders
DescribeRecommender
UpdateRecommender
DeleteRecommender
See also: AWS API Documentation
Request Syntax
client.create_recommender(
name='string',
datasetGroupArn='string',
recipeArn='string',
recommenderConfig={
'itemExplorationConfig': {
'string': 'string'
}
}
)
string
[REQUIRED]
The name of the recommender.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see Choosing recommender use cases.
dict
The configuration details of the recommender.
itemExplorationConfig (dict) --
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
(string) --
(string) --
dict
Response Syntax
{
'recommenderArn': 'string'
}
Response Structure
(dict) --
recommenderArn (string) --
The Amazon Resource Name (ARN) of the recommender.
Gets the properties of a batch segment job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate segments.
See also: AWS API Documentation
Request Syntax
client.describe_batch_segment_job(
batchSegmentJobArn='string'
)
string
[REQUIRED]
The ARN of the batch segment job to describe.
dict
Response Syntax
{
'batchSegmentJob': {
'jobName': 'string',
'batchSegmentJobArn': 'string',
'filterArn': 'string',
'failureReason': 'string',
'solutionVersionArn': 'string',
'numResults': 123,
'jobInput': {
's3DataSource': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
'jobOutput': {
's3DataDestination': {
'path': 'string',
'kmsKeyArn': 'string'
}
},
'roleArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
batchSegmentJob (dict) --
Information on the specified batch segment job.
jobName (string) --
The name of the batch segment job.
batchSegmentJobArn (string) --
The Amazon Resource Name (ARN) of the batch segment job.
filterArn (string) --
The ARN of the filter used on the batch segment job.
failureReason (string) --
If the batch segment job failed, the reason for the failure.
solutionVersionArn (string) --
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
numResults (integer) --
The number of predicted users generated by the batch segment job for each line of input data.
jobInput (dict) --
The Amazon S3 path that leads to the input data used to generate the batch segment job.
s3DataSource (dict) --
The configuration details of an Amazon S3 input or output bucket.
path (string) --
The file path of the Amazon S3 bucket.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
jobOutput (dict) --
The Amazon S3 bucket that contains the output data generated by the batch segment job.
s3DataDestination (dict) --
The configuration details of an Amazon S3 input or output bucket.
path (string) --
The file path of the Amazon S3 bucket.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
roleArn (string) --
The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.
status (string) --
The status of the batch segment job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
creationDateTime (datetime) --
The time at which the batch segment job was created.
lastUpdatedDateTime (datetime) --
The time at which the batch segment job last updated.
Describes the given recommender, including its status.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
When the status is CREATE FAILED , the response includes the failureReason key, which describes why.
For more information on recommenders, see CreateRecommender.
See also: AWS API Documentation
Request Syntax
client.describe_recommender(
recommenderArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the recommender to describe.
dict
Response Syntax
{
'recommender': {
'recommenderArn': 'string',
'datasetGroupArn': 'string',
'name': 'string',
'recipeArn': 'string',
'recommenderConfig': {
'itemExplorationConfig': {
'string': 'string'
}
},
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'status': 'string',
'failureReason': 'string',
'latestRecommenderUpdate': {
'recommenderConfig': {
'itemExplorationConfig': {
'string': 'string'
}
},
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'status': 'string',
'failureReason': 'string'
}
}
}
Response Structure
(dict) --
recommender (dict) --
The properties of the recommender.
recommenderArn (string) --
The Amazon Resource Name (ARN) of the recommender.
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.
name (string) --
The name of the recommender.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
recommenderConfig (dict) --
The configuration details of the recommender.
itemExplorationConfig (dict) --
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
(string) --
(string) --
creationDateTime (datetime) --
The date and time (in Unix format) that the recommender was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix format) that the recommender was last updated.
status (string) --
The status of the recommender.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
failureReason (string) --
If a recommender fails, the reason behind the failure.
latestRecommenderUpdate (dict) --
Provides a summary of the latest updates to the recommender.
recommenderConfig (dict) --
The configuration details of the recommender update.
itemExplorationConfig (dict) --
Specifies the exploration configuration hyperparameters, including explorationWeight and explorationItemAgeCutOff , you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items. Provide itemExplorationConfig data only if your recommenders generate personalized recommendations for a user (not popular items or similar items).
(string) --
(string) --
creationDateTime (datetime) --
The date and time (in Unix format) that the recommender update was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the recommender update was last updated.
status (string) --
The status of the recommender update.
A recommender can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING > DELETE IN_PROGRESS
failureReason (string) --
If a recommender update fails, the reason behind the failure.
Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.
See also: AWS API Documentation
Request Syntax
client.list_batch_segment_jobs(
solutionVersionArn='string',
nextToken='string',
maxResults=123
)
string
The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.
string
The token to request the next page of results.
integer
The maximum number of batch segment job results to return in each page. The default value is 100.
dict
Response Syntax
{
'batchSegmentJobs': [
{
'batchSegmentJobArn': 'string',
'jobName': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'solutionVersionArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
batchSegmentJobs (list) --
A list containing information on each job that is returned.
(dict) --
A truncated version of the BatchSegmentJob datatype. The ListBatchSegmentJobs operation returns a list of batch segment job summaries.
batchSegmentJobArn (string) --
The Amazon Resource Name (ARN) of the batch segment job.
jobName (string) --
The name of the batch segment job.
status (string) --
The status of the batch segment job. The status is one of the following values:
PENDING
IN PROGRESS
ACTIVE
CREATE FAILED
creationDateTime (datetime) --
The time at which the batch segment job was created.
lastUpdatedDateTime (datetime) --
The time at which the batch segment job was last updated.
failureReason (string) --
If the batch segment job failed, the reason for the failure.
solutionVersionArn (string) --
The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.
nextToken (string) --
The token to use to retrieve the next page of results. The value is null when there are no more results to return.
{'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}
Creates an empty dataset group. A dataset group is a container for Amazon Personalize resources. A dataset group can contain at most three datasets, one for each type of dataset:
Interactions
Items
Users
A dataset group can be a Domain dataset group, where you specify a domain and use pre-configured resources like recommenders, or a Custom dataset group, where you use custom resources, such as a solution with a solution version, that you deploy with a campaign. If you start with a Domain dataset group, you can still add custom resources such as solutions and solution versions trained with recipes for custom use cases and deployed with campaigns.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.
Note
You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.
You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key.
APIs that require a dataset group ARN in the request
CreateDataset
CreateEventTracker
CreateSolution
Related APIs
ListDatasetGroups
DescribeDatasetGroup
DeleteDatasetGroup
See also: AWS API Documentation
Request Syntax
client.create_dataset_group(
name='string',
roleArn='string',
kmsKeyArn='string',
domain='ECOMMERCE'|'VIDEO_ON_DEMAND'
)
string
[REQUIRED]
The name for the new dataset group.
string
The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
string
The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
string
The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain, you create a Custom dataset group with solution versions that you deploy with a campaign.
dict
Response Syntax
{
'datasetGroupArn': 'string',
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
}
Response Structure
(dict) --
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the new dataset group.
domain (string) --
The domain for the new Domain dataset group.
{'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}
Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.
Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.
Related APIs
ListSchemas
DescribeSchema
DeleteSchema
See also: AWS API Documentation
Request Syntax
client.create_schema(
name='string',
schema='string',
domain='ECOMMERCE'|'VIDEO_ON_DEMAND'
)
string
[REQUIRED]
The name for the schema.
string
[REQUIRED]
A schema in Avro JSON format.
string
The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.
dict
Response Syntax
{
'schemaArn': 'string'
}
Response Structure
(dict) --
schemaArn (string) --
The Amazon Resource Name (ARN) of the created schema.
{'datasetGroup': {'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}}
Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.
See also: AWS API Documentation
Request Syntax
client.describe_dataset_group(
datasetGroupArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the dataset group to describe.
dict
Response Syntax
{
'datasetGroup': {
'name': 'string',
'datasetGroupArn': 'string',
'status': 'string',
'roleArn': 'string',
'kmsKeyArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
}
}
Response Structure
(dict) --
datasetGroup (dict) --
A listing of the dataset group's properties.
name (string) --
The name of the dataset group.
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the dataset group.
status (string) --
The current status of the dataset group.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
roleArn (string) --
The ARN of the IAM role that has permissions to create the dataset group.
kmsKeyArn (string) --
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
creationDateTime (datetime) --
The creation date and time (in Unix time) of the dataset group.
lastUpdatedDateTime (datetime) --
The last update date and time (in Unix time) of the dataset group.
failureReason (string) --
If creating a dataset group fails, provides the reason why.
domain (string) --
The domain of a Domain dataset group.
{'schema': {'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}}
Describes a schema. For more information on schemas, see CreateSchema.
See also: AWS API Documentation
Request Syntax
client.describe_schema(
schemaArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the schema to retrieve.
dict
Response Syntax
{
'schema': {
'name': 'string',
'schemaArn': 'string',
'schema': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
}
}
Response Structure
(dict) --
schema (dict) --
The requested schema.
name (string) --
The name of the schema.
schemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
schema (string) --
The schema.
creationDateTime (datetime) --
The date and time (in Unix time) that the schema was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the schema was last updated.
domain (string) --
The domain of a schema that you created for a dataset in a Domain dataset group.
{'datasetGroups': {'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}}
Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.
See also: AWS API Documentation
Request Syntax
client.list_dataset_groups(
nextToken='string',
maxResults=123
)
string
A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).
integer
The maximum number of dataset groups to return.
dict
Response Syntax
{
'datasetGroups': [
{
'name': 'string',
'datasetGroupArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'failureReason': 'string',
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
datasetGroups (list) --
The list of your dataset groups.
(dict) --
Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.
name (string) --
The name of the dataset group.
datasetGroupArn (string) --
The Amazon Resource Name (ARN) of the dataset group.
status (string) --
The status of the dataset group.
A dataset group can be in one of the following states:
CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
DELETE PENDING
creationDateTime (datetime) --
The date and time (in Unix time) that the dataset group was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the dataset group was last updated.
failureReason (string) --
If creating a dataset group fails, the reason behind the failure.
domain (string) --
The domain of a Domain dataset group.
nextToken (string) --
A token for getting the next set of dataset groups (if they exist).
{'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}
Response {'recipes': {'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}}
Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).
See also: AWS API Documentation
Request Syntax
client.list_recipes(
recipeProvider='SERVICE',
nextToken='string',
maxResults=123,
domain='ECOMMERCE'|'VIDEO_ON_DEMAND'
)
string
The default is SERVICE .
string
A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).
integer
The maximum number of recipes to return.
string
Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases) for this domain are included in the response. If you don't specify a domain, only non-domain recipes are returned.
dict
Response Syntax
{
'recipes': [
{
'name': 'string',
'recipeArn': 'string',
'status': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
recipes (list) --
The list of available recipes.
(dict) --
Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.
name (string) --
The name of the recipe.
recipeArn (string) --
The Amazon Resource Name (ARN) of the recipe.
status (string) --
The status of the recipe.
creationDateTime (datetime) --
The date and time (in Unix time) that the recipe was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the recipe was last updated.
domain (string) --
The domain of the recipe (if the recipe is a Domain dataset group use case).
nextToken (string) --
A token for getting the next set of recipes.
{'schemas': {'domain': 'ECOMMERCE | VIDEO_ON_DEMAND'}}
Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.
See also: AWS API Documentation
Request Syntax
client.list_schemas(
nextToken='string',
maxResults=123
)
string
A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).
integer
The maximum number of schemas to return.
dict
Response Syntax
{
'schemas': [
{
'name': 'string',
'schemaArn': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
schemas (list) --
A list of schemas.
(dict) --
Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.
name (string) --
The name of the schema.
schemaArn (string) --
The Amazon Resource Name (ARN) of the schema.
creationDateTime (datetime) --
The date and time (in Unix time) that the schema was created.
lastUpdatedDateTime (datetime) --
The date and time (in Unix time) that the schema was last updated.
domain (string) --
The domain of a schema that you created for a dataset in a Domain dataset group.
nextToken (string) --
A token used to get the next set of schemas (if they exist).