PersonalizeClient

Index > Personalize > PersonalizeClient

Auto-generated documentation for Personalize type annotations stubs module mypy-boto3-personalize.

PersonalizeClient

Type annotations and code completion for boto3.client("personalize"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_personalize.client import PersonalizeClient

def get_personalize_client() -> PersonalizeClient:
    return Session().client("personalize")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("personalize").exceptions structure.

Usage example

client = boto3.client("personalize")

try:
    do_something(client)
except (
    client.ClientError,
    client.InvalidInputException,
    client.InvalidNextTokenException,
    client.LimitExceededException,
    client.ResourceAlreadyExistsException,
    client.ResourceInUseException,
    client.ResourceNotFoundException,
    client.TooManyTagKeysException,
    client.TooManyTagsException,
) as e:
    print(e)

Type checking example

from mypy_boto3_personalize.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("personalize").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("personalize").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

create_batch_inference_job

Creates a batch inference job.

Type annotations and code completion for boto3.client("personalize").create_batch_inference_job method. boto3 documentation

Method definition

def create_batch_inference_job(
    self,
    *,
    jobName: str,
    solutionVersionArn: str,
    jobInput: BatchInferenceJobInputTypeDef,  # (1)
    jobOutput: BatchInferenceJobOutputTypeDef,  # (2)
    roleArn: str,
    filterArn: str = ...,
    numResults: int = ...,
    batchInferenceJobConfig: BatchInferenceJobConfigTypeDef = ...,  # (3)
    tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateBatchInferenceJobResponseTypeDef:  # (5)
    ...

1. See BatchInferenceJobInputTypeDef
2. See BatchInferenceJobOutputTypeDef
3. See BatchInferenceJobConfigTypeDef
4. See TagTypeDef
5. See CreateBatchInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: CreateBatchInferenceJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "solutionVersionArn": ...,
    "jobInput": ...,
    "jobOutput": ...,
    "roleArn": ...,
}

parent.create_batch_inference_job(**kwargs)

1. See CreateBatchInferenceJobRequestRequestTypeDef

create_batch_segment_job

Creates a batch segment job.

Type annotations and code completion for boto3.client("personalize").create_batch_segment_job method. boto3 documentation

Method definition

def create_batch_segment_job(
    self,
    *,
    jobName: str,
    solutionVersionArn: str,
    jobInput: BatchSegmentJobInputTypeDef,  # (1)
    jobOutput: BatchSegmentJobOutputTypeDef,  # (2)
    roleArn: str,
    filterArn: str = ...,
    numResults: int = ...,
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateBatchSegmentJobResponseTypeDef:  # (4)
    ...

1. See BatchSegmentJobInputTypeDef
2. See BatchSegmentJobOutputTypeDef
3. See TagTypeDef
4. See CreateBatchSegmentJobResponseTypeDef

Usage example with kwargs

kwargs: CreateBatchSegmentJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "solutionVersionArn": ...,
    "jobInput": ...,
    "jobOutput": ...,
    "roleArn": ...,
}

parent.create_batch_segment_job(**kwargs)

1. See CreateBatchSegmentJobRequestRequestTypeDef

create_campaign

Creates a campaign that deploys a solution version.

Type annotations and code completion for boto3.client("personalize").create_campaign method. boto3 documentation

Method definition

def create_campaign(
    self,
    *,
    name: str,
    solutionVersionArn: str,
    minProvisionedTPS: int = ...,
    campaignConfig: CampaignConfigTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateCampaignResponseTypeDef:  # (3)
    ...

1. See CampaignConfigTypeDef
2. See TagTypeDef
3. See CreateCampaignResponseTypeDef

Usage example with kwargs

kwargs: CreateCampaignRequestRequestTypeDef = {  # (1)
    "name": ...,
    "solutionVersionArn": ...,
}

parent.create_campaign(**kwargs)

1. See CreateCampaignRequestRequestTypeDef

create_dataset

Creates an empty dataset and adds it to the specified dataset group.

Type annotations and code completion for boto3.client("personalize").create_dataset method. boto3 documentation

Method definition

def create_dataset(
    self,
    *,
    name: str,
    schemaArn: str,
    datasetGroupArn: str,
    datasetType: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDatasetResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateDatasetResponseTypeDef

Usage example with kwargs

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "name": ...,
    "schemaArn": ...,
    "datasetGroupArn": ...,
    "datasetType": ...,
}

parent.create_dataset(**kwargs)

1. See CreateDatasetRequestRequestTypeDef

create_dataset_export_job

Creates a job that exports data from your dataset to an Amazon S3 bucket.

Type annotations and code completion for boto3.client("personalize").create_dataset_export_job method. boto3 documentation

Method definition

def create_dataset_export_job(
    self,
    *,
    jobName: str,
    datasetArn: str,
    roleArn: str,
    jobOutput: DatasetExportJobOutputTypeDef,  # (1)
    ingestionMode: IngestionModeType = ...,  # (2)
    tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateDatasetExportJobResponseTypeDef:  # (4)
    ...

1. See DatasetExportJobOutputTypeDef
2. See IngestionModeType
3. See TagTypeDef
4. See CreateDatasetExportJobResponseTypeDef

Usage example with kwargs

kwargs: CreateDatasetExportJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "datasetArn": ...,
    "roleArn": ...,
    "jobOutput": ...,
}

parent.create_dataset_export_job(**kwargs)

1. See CreateDatasetExportJobRequestRequestTypeDef

create_dataset_group

Creates an empty dataset group.

Type annotations and code completion for boto3.client("personalize").create_dataset_group method. boto3 documentation

Method definition

def create_dataset_group(
    self,
    *,
    name: str,
    roleArn: str = ...,
    kmsKeyArn: str = ...,
    domain: DomainType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateDatasetGroupResponseTypeDef:  # (3)
    ...

1. See DomainType
2. See TagTypeDef
3. See CreateDatasetGroupResponseTypeDef

Usage example with kwargs

kwargs: CreateDatasetGroupRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_dataset_group(**kwargs)

1. See CreateDatasetGroupRequestRequestTypeDef

create_dataset_import_job

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset.

Type annotations and code completion for boto3.client("personalize").create_dataset_import_job method. boto3 documentation

Method definition

def create_dataset_import_job(
    self,
    *,
    jobName: str,
    datasetArn: str,
    dataSource: DataSourceTypeDef,  # (1)
    roleArn: str,
    tags: Sequence[TagTypeDef] = ...,  # (2)
    importMode: ImportModeType = ...,  # (3)
    publishAttributionMetricsToS3: bool = ...,
) -> CreateDatasetImportJobResponseTypeDef:  # (4)
    ...

1. See DataSourceTypeDef
2. See TagTypeDef
3. See ImportModeType
4. See CreateDatasetImportJobResponseTypeDef

Usage example with kwargs

kwargs: CreateDatasetImportJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "datasetArn": ...,
    "dataSource": ...,
    "roleArn": ...,
}

parent.create_dataset_import_job(**kwargs)

1. See CreateDatasetImportJobRequestRequestTypeDef

create_event_tracker

Creates an event tracker that you use when adding event data to a specified dataset group using the PutEvents_ API.

Type annotations and code completion for boto3.client("personalize").create_event_tracker method. boto3 documentation

Method definition

def create_event_tracker(
    self,
    *,
    name: str,
    datasetGroupArn: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateEventTrackerResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateEventTrackerResponseTypeDef

Usage example with kwargs

kwargs: CreateEventTrackerRequestRequestTypeDef = {  # (1)
    "name": ...,
    "datasetGroupArn": ...,
}

parent.create_event_tracker(**kwargs)

1. See CreateEventTrackerRequestRequestTypeDef

create_filter

Creates a recommendation filter.

Type annotations and code completion for boto3.client("personalize").create_filter method. boto3 documentation

Method definition

def create_filter(
    self,
    *,
    name: str,
    datasetGroupArn: str,
    filterExpression: str,
    tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateFilterResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateFilterResponseTypeDef

Usage example with kwargs

kwargs: CreateFilterRequestRequestTypeDef = {  # (1)
    "name": ...,
    "datasetGroupArn": ...,
    "filterExpression": ...,
}

parent.create_filter(**kwargs)

1. See CreateFilterRequestRequestTypeDef

create_metric_attribution

Creates a metric attribution.

Type annotations and code completion for boto3.client("personalize").create_metric_attribution method. boto3 documentation

Method definition

def create_metric_attribution(
    self,
    *,
    name: str,
    datasetGroupArn: str,
    metrics: Sequence[MetricAttributeTypeDef],  # (1)
    metricsOutputConfig: MetricAttributionOutputTypeDef,  # (2)
) -> CreateMetricAttributionResponseTypeDef:  # (3)
    ...

1. See MetricAttributeTypeDef
2. See MetricAttributionOutputTypeDef
3. See CreateMetricAttributionResponseTypeDef

Usage example with kwargs

kwargs: CreateMetricAttributionRequestRequestTypeDef = {  # (1)
    "name": ...,
    "datasetGroupArn": ...,
    "metrics": ...,
    "metricsOutputConfig": ...,
}

parent.create_metric_attribution(**kwargs)

1. See CreateMetricAttributionRequestRequestTypeDef

create_recommender

Creates a recommender with the recipe (a Domain dataset group use case) you specify.

Type annotations and code completion for boto3.client("personalize").create_recommender method. boto3 documentation

Method definition

def create_recommender(
    self,
    *,
    name: str,
    datasetGroupArn: str,
    recipeArn: str,
    recommenderConfig: RecommenderConfigTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateRecommenderResponseTypeDef:  # (3)
    ...

1. See RecommenderConfigTypeDef
2. See TagTypeDef
3. See CreateRecommenderResponseTypeDef

Usage example with kwargs

kwargs: CreateRecommenderRequestRequestTypeDef = {  # (1)
    "name": ...,
    "datasetGroupArn": ...,
    "recipeArn": ...,
}

parent.create_recommender(**kwargs)

1. See CreateRecommenderRequestRequestTypeDef

create_schema

Creates an Amazon Personalize schema from the specified schema string.

Type annotations and code completion for boto3.client("personalize").create_schema method. boto3 documentation

Method definition

def create_schema(
    self,
    *,
    name: str,
    schema: str,
    domain: DomainType = ...,  # (1)
) -> CreateSchemaResponseTypeDef:  # (2)
    ...

1. See DomainType
2. See CreateSchemaResponseTypeDef

Usage example with kwargs

kwargs: CreateSchemaRequestRequestTypeDef = {  # (1)
    "name": ...,
    "schema": ...,
}

parent.create_schema(**kwargs)

1. See CreateSchemaRequestRequestTypeDef

create_solution

Creates the configuration for training a model.

Type annotations and code completion for boto3.client("personalize").create_solution method. boto3 documentation

Method definition

def create_solution(
    self,
    *,
    name: str,
    datasetGroupArn: str,
    performHPO: bool = ...,
    performAutoML: bool = ...,
    recipeArn: str = ...,
    eventType: str = ...,
    solutionConfig: SolutionConfigTypeDef = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateSolutionResponseTypeDef:  # (3)
    ...

1. See SolutionConfigTypeDef
2. See TagTypeDef
3. See CreateSolutionResponseTypeDef

Usage example with kwargs

kwargs: CreateSolutionRequestRequestTypeDef = {  # (1)
    "name": ...,
    "datasetGroupArn": ...,
}

parent.create_solution(**kwargs)

1. See CreateSolutionRequestRequestTypeDef

create_solution_version

Trains or retrains an active solution in a Custom dataset group.

Type annotations and code completion for boto3.client("personalize").create_solution_version method. boto3 documentation

Method definition

def create_solution_version(
    self,
    *,
    solutionArn: str,
    name: str = ...,
    trainingMode: TrainingModeType = ...,  # (1)
    tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateSolutionVersionResponseTypeDef:  # (3)
    ...

1. See TrainingModeType
2. See TagTypeDef
3. See CreateSolutionVersionResponseTypeDef

Usage example with kwargs

kwargs: CreateSolutionVersionRequestRequestTypeDef = {  # (1)
    "solutionArn": ...,
}

parent.create_solution_version(**kwargs)

1. See CreateSolutionVersionRequestRequestTypeDef

delete_campaign

Removes a campaign by deleting the solution deployment.

Type annotations and code completion for boto3.client("personalize").delete_campaign method. boto3 documentation

Method definition

def delete_campaign(
    self,
    *,
    campaignArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteCampaignRequestRequestTypeDef = {  # (1)
    "campaignArn": ...,
}

parent.delete_campaign(**kwargs)

1. See DeleteCampaignRequestRequestTypeDef

delete_dataset

Deletes a dataset.

Type annotations and code completion for boto3.client("personalize").delete_dataset method. boto3 documentation

Method definition

def delete_dataset(
    self,
    *,
    datasetArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteDatasetRequestRequestTypeDef = {  # (1)
    "datasetArn": ...,
}

parent.delete_dataset(**kwargs)

1. See DeleteDatasetRequestRequestTypeDef

delete_dataset_group

Deletes a dataset group.

Type annotations and code completion for boto3.client("personalize").delete_dataset_group method. boto3 documentation

Method definition

def delete_dataset_group(
    self,
    *,
    datasetGroupArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteDatasetGroupRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.delete_dataset_group(**kwargs)

1. See DeleteDatasetGroupRequestRequestTypeDef

delete_event_tracker

Deletes the event tracker.

Type annotations and code completion for boto3.client("personalize").delete_event_tracker method. boto3 documentation

Method definition

def delete_event_tracker(
    self,
    *,
    eventTrackerArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteEventTrackerRequestRequestTypeDef = {  # (1)
    "eventTrackerArn": ...,
}

parent.delete_event_tracker(**kwargs)

1. See DeleteEventTrackerRequestRequestTypeDef

delete_filter

Deletes a filter.

Type annotations and code completion for boto3.client("personalize").delete_filter method. boto3 documentation

Method definition

def delete_filter(
    self,
    *,
    filterArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteFilterRequestRequestTypeDef = {  # (1)
    "filterArn": ...,
}

parent.delete_filter(**kwargs)

1. See DeleteFilterRequestRequestTypeDef

delete_metric_attribution

Deletes a metric attribution.

Type annotations and code completion for boto3.client("personalize").delete_metric_attribution method. boto3 documentation

Method definition

def delete_metric_attribution(
    self,
    *,
    metricAttributionArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteMetricAttributionRequestRequestTypeDef = {  # (1)
    "metricAttributionArn": ...,
}

parent.delete_metric_attribution(**kwargs)

1. See DeleteMetricAttributionRequestRequestTypeDef

delete_recommender

Deactivates and removes a recommender.

Type annotations and code completion for boto3.client("personalize").delete_recommender method. boto3 documentation

Method definition

def delete_recommender(
    self,
    *,
    recommenderArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteRecommenderRequestRequestTypeDef = {  # (1)
    "recommenderArn": ...,
}

parent.delete_recommender(**kwargs)

1. See DeleteRecommenderRequestRequestTypeDef

delete_schema

Deletes a schema.

Type annotations and code completion for boto3.client("personalize").delete_schema method. boto3 documentation

Method definition

def delete_schema(
    self,
    *,
    schemaArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteSchemaRequestRequestTypeDef = {  # (1)
    "schemaArn": ...,
}

parent.delete_schema(**kwargs)

1. See DeleteSchemaRequestRequestTypeDef

delete_solution

Deletes all versions of a solution and the Solution object itself.

Type annotations and code completion for boto3.client("personalize").delete_solution method. boto3 documentation

Method definition

def delete_solution(
    self,
    *,
    solutionArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteSolutionRequestRequestTypeDef = {  # (1)
    "solutionArn": ...,
}

parent.delete_solution(**kwargs)

1. See DeleteSolutionRequestRequestTypeDef

describe_algorithm

Describes the given algorithm.

Type annotations and code completion for boto3.client("personalize").describe_algorithm method. boto3 documentation

Method definition

def describe_algorithm(
    self,
    *,
    algorithmArn: str,
) -> DescribeAlgorithmResponseTypeDef:  # (1)
    ...

1. See DescribeAlgorithmResponseTypeDef

Usage example with kwargs

kwargs: DescribeAlgorithmRequestRequestTypeDef = {  # (1)
    "algorithmArn": ...,
}

parent.describe_algorithm(**kwargs)

1. See DescribeAlgorithmRequestRequestTypeDef

describe_batch_inference_job

Gets the properties of a batch inference job including name, Amazon Resource Name (ARN), status, input and output configurations, and the ARN of the solution version used to generate the recommendations.

Type annotations and code completion for boto3.client("personalize").describe_batch_inference_job method. boto3 documentation

Method definition

def describe_batch_inference_job(
    self,
    *,
    batchInferenceJobArn: str,
) -> DescribeBatchInferenceJobResponseTypeDef:  # (1)
    ...

1. See DescribeBatchInferenceJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeBatchInferenceJobRequestRequestTypeDef = {  # (1)
    "batchInferenceJobArn": ...,
}

parent.describe_batch_inference_job(**kwargs)

1. See DescribeBatchInferenceJobRequestRequestTypeDef

describe_batch_segment_job

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.

Type annotations and code completion for boto3.client("personalize").describe_batch_segment_job method. boto3 documentation

Method definition

def describe_batch_segment_job(
    self,
    *,
    batchSegmentJobArn: str,
) -> DescribeBatchSegmentJobResponseTypeDef:  # (1)
    ...

1. See DescribeBatchSegmentJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeBatchSegmentJobRequestRequestTypeDef = {  # (1)
    "batchSegmentJobArn": ...,
}

parent.describe_batch_segment_job(**kwargs)

1. See DescribeBatchSegmentJobRequestRequestTypeDef

describe_campaign

Describes the given campaign, including its status.

Type annotations and code completion for boto3.client("personalize").describe_campaign method. boto3 documentation

Method definition

def describe_campaign(
    self,
    *,
    campaignArn: str,
) -> DescribeCampaignResponseTypeDef:  # (1)
    ...

1. See DescribeCampaignResponseTypeDef

Usage example with kwargs

kwargs: DescribeCampaignRequestRequestTypeDef = {  # (1)
    "campaignArn": ...,
}

parent.describe_campaign(**kwargs)

1. See DescribeCampaignRequestRequestTypeDef

describe_dataset

Describes the given dataset.

Type annotations and code completion for boto3.client("personalize").describe_dataset method. boto3 documentation

Method definition

def describe_dataset(
    self,
    *,
    datasetArn: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetResponseTypeDef

Usage example with kwargs

kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "datasetArn": ...,
}

parent.describe_dataset(**kwargs)

1. See DescribeDatasetRequestRequestTypeDef

describe_dataset_export_job

Describes the dataset export job created by CreateDatasetExportJob_, including the export job status.

Type annotations and code completion for boto3.client("personalize").describe_dataset_export_job method. boto3 documentation

Method definition

def describe_dataset_export_job(
    self,
    *,
    datasetExportJobArn: str,
) -> DescribeDatasetExportJobResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetExportJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeDatasetExportJobRequestRequestTypeDef = {  # (1)
    "datasetExportJobArn": ...,
}

parent.describe_dataset_export_job(**kwargs)

1. See DescribeDatasetExportJobRequestRequestTypeDef

describe_dataset_group

Describes the given dataset group.

Type annotations and code completion for boto3.client("personalize").describe_dataset_group method. boto3 documentation

Method definition

def describe_dataset_group(
    self,
    *,
    datasetGroupArn: str,
) -> DescribeDatasetGroupResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetGroupResponseTypeDef

Usage example with kwargs

kwargs: DescribeDatasetGroupRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.describe_dataset_group(**kwargs)

1. See DescribeDatasetGroupRequestRequestTypeDef

describe_dataset_import_job

Describes the dataset import job created by CreateDatasetImportJob_, including the import job status.

Type annotations and code completion for boto3.client("personalize").describe_dataset_import_job method. boto3 documentation

Method definition

def describe_dataset_import_job(
    self,
    *,
    datasetImportJobArn: str,
) -> DescribeDatasetImportJobResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetImportJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeDatasetImportJobRequestRequestTypeDef = {  # (1)
    "datasetImportJobArn": ...,
}

parent.describe_dataset_import_job(**kwargs)

1. See DescribeDatasetImportJobRequestRequestTypeDef

describe_event_tracker

Describes an event tracker.

Type annotations and code completion for boto3.client("personalize").describe_event_tracker method. boto3 documentation

Method definition

def describe_event_tracker(
    self,
    *,
    eventTrackerArn: str,
) -> DescribeEventTrackerResponseTypeDef:  # (1)
    ...

1. See DescribeEventTrackerResponseTypeDef

Usage example with kwargs

kwargs: DescribeEventTrackerRequestRequestTypeDef = {  # (1)
    "eventTrackerArn": ...,
}

parent.describe_event_tracker(**kwargs)

1. See DescribeEventTrackerRequestRequestTypeDef

describe_feature_transformation

Describes the given feature transformation.

Type annotations and code completion for boto3.client("personalize").describe_feature_transformation method. boto3 documentation

Method definition

def describe_feature_transformation(
    self,
    *,
    featureTransformationArn: str,
) -> DescribeFeatureTransformationResponseTypeDef:  # (1)
    ...

1. See DescribeFeatureTransformationResponseTypeDef

Usage example with kwargs

kwargs: DescribeFeatureTransformationRequestRequestTypeDef = {  # (1)
    "featureTransformationArn": ...,
}

parent.describe_feature_transformation(**kwargs)

1. See DescribeFeatureTransformationRequestRequestTypeDef

describe_filter

Describes a filter's properties.

Type annotations and code completion for boto3.client("personalize").describe_filter method. boto3 documentation

Method definition

def describe_filter(
    self,
    *,
    filterArn: str,
) -> DescribeFilterResponseTypeDef:  # (1)
    ...

1. See DescribeFilterResponseTypeDef

Usage example with kwargs

kwargs: DescribeFilterRequestRequestTypeDef = {  # (1)
    "filterArn": ...,
}

parent.describe_filter(**kwargs)

1. See DescribeFilterRequestRequestTypeDef

describe_metric_attribution

Describes a metric attribution.

Type annotations and code completion for boto3.client("personalize").describe_metric_attribution method. boto3 documentation

Method definition

def describe_metric_attribution(
    self,
    *,
    metricAttributionArn: str,
) -> DescribeMetricAttributionResponseTypeDef:  # (1)
    ...

1. See DescribeMetricAttributionResponseTypeDef

Usage example with kwargs

kwargs: DescribeMetricAttributionRequestRequestTypeDef = {  # (1)
    "metricAttributionArn": ...,
}

parent.describe_metric_attribution(**kwargs)

1. See DescribeMetricAttributionRequestRequestTypeDef

describe_recipe

Describes a recipe.

Type annotations and code completion for boto3.client("personalize").describe_recipe method. boto3 documentation

Method definition

def describe_recipe(
    self,
    *,
    recipeArn: str,
) -> DescribeRecipeResponseTypeDef:  # (1)
    ...

1. See DescribeRecipeResponseTypeDef

Usage example with kwargs

kwargs: DescribeRecipeRequestRequestTypeDef = {  # (1)
    "recipeArn": ...,
}

parent.describe_recipe(**kwargs)

1. See DescribeRecipeRequestRequestTypeDef

describe_recommender

Describes the given recommender, including its status.

Type annotations and code completion for boto3.client("personalize").describe_recommender method. boto3 documentation

Method definition

def describe_recommender(
    self,
    *,
    recommenderArn: str,
) -> DescribeRecommenderResponseTypeDef:  # (1)
    ...

1. See DescribeRecommenderResponseTypeDef

Usage example with kwargs

kwargs: DescribeRecommenderRequestRequestTypeDef = {  # (1)
    "recommenderArn": ...,
}

parent.describe_recommender(**kwargs)

1. See DescribeRecommenderRequestRequestTypeDef

describe_schema

Describes a schema.

Type annotations and code completion for boto3.client("personalize").describe_schema method. boto3 documentation

Method definition

def describe_schema(
    self,
    *,
    schemaArn: str,
) -> DescribeSchemaResponseTypeDef:  # (1)
    ...

1. See DescribeSchemaResponseTypeDef

Usage example with kwargs

kwargs: DescribeSchemaRequestRequestTypeDef = {  # (1)
    "schemaArn": ...,
}

parent.describe_schema(**kwargs)

1. See DescribeSchemaRequestRequestTypeDef

describe_solution

Describes a solution.

Type annotations and code completion for boto3.client("personalize").describe_solution method. boto3 documentation

Method definition

def describe_solution(
    self,
    *,
    solutionArn: str,
) -> DescribeSolutionResponseTypeDef:  # (1)
    ...

1. See DescribeSolutionResponseTypeDef

Usage example with kwargs

kwargs: DescribeSolutionRequestRequestTypeDef = {  # (1)
    "solutionArn": ...,
}

parent.describe_solution(**kwargs)

1. See DescribeSolutionRequestRequestTypeDef

describe_solution_version

Describes a specific version of a solution.

Type annotations and code completion for boto3.client("personalize").describe_solution_version method. boto3 documentation

Method definition

def describe_solution_version(
    self,
    *,
    solutionVersionArn: str,
) -> DescribeSolutionVersionResponseTypeDef:  # (1)
    ...

1. See DescribeSolutionVersionResponseTypeDef

Usage example with kwargs

kwargs: DescribeSolutionVersionRequestRequestTypeDef = {  # (1)
    "solutionVersionArn": ...,
}

parent.describe_solution_version(**kwargs)

1. See DescribeSolutionVersionRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("personalize").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_solution_metrics

Gets the metrics for the specified solution version.

Type annotations and code completion for boto3.client("personalize").get_solution_metrics method. boto3 documentation

Method definition

def get_solution_metrics(
    self,
    *,
    solutionVersionArn: str,
) -> GetSolutionMetricsResponseTypeDef:  # (1)
    ...

1. See GetSolutionMetricsResponseTypeDef

Usage example with kwargs

kwargs: GetSolutionMetricsRequestRequestTypeDef = {  # (1)
    "solutionVersionArn": ...,
}

parent.get_solution_metrics(**kwargs)

1. See GetSolutionMetricsRequestRequestTypeDef

list_batch_inference_jobs

Gets a list of the batch inference jobs that have been performed off of a solution version.

Type annotations and code completion for boto3.client("personalize").list_batch_inference_jobs method. boto3 documentation

Method definition

def list_batch_inference_jobs(
    self,
    *,
    solutionVersionArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListBatchInferenceJobsResponseTypeDef:  # (1)
    ...

1. See ListBatchInferenceJobsResponseTypeDef

Usage example with kwargs

kwargs: ListBatchInferenceJobsRequestRequestTypeDef = {  # (1)
    "solutionVersionArn": ...,
}

parent.list_batch_inference_jobs(**kwargs)

1. See ListBatchInferenceJobsRequestRequestTypeDef

list_batch_segment_jobs

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

Type annotations and code completion for boto3.client("personalize").list_batch_segment_jobs method. boto3 documentation

Method definition

def list_batch_segment_jobs(
    self,
    *,
    solutionVersionArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListBatchSegmentJobsResponseTypeDef:  # (1)
    ...

1. See ListBatchSegmentJobsResponseTypeDef

Usage example with kwargs

kwargs: ListBatchSegmentJobsRequestRequestTypeDef = {  # (1)
    "solutionVersionArn": ...,
}

parent.list_batch_segment_jobs(**kwargs)

1. See ListBatchSegmentJobsRequestRequestTypeDef

list_campaigns

Returns a list of campaigns that use the given solution.

Type annotations and code completion for boto3.client("personalize").list_campaigns method. boto3 documentation

Method definition

def list_campaigns(
    self,
    *,
    solutionArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCampaignsResponseTypeDef:  # (1)
    ...

1. See ListCampaignsResponseTypeDef

Usage example with kwargs

kwargs: ListCampaignsRequestRequestTypeDef = {  # (1)
    "solutionArn": ...,
}

parent.list_campaigns(**kwargs)

1. See ListCampaignsRequestRequestTypeDef

list_dataset_export_jobs

Returns a list of dataset export jobs that use the given dataset.

Type annotations and code completion for boto3.client("personalize").list_dataset_export_jobs method. boto3 documentation

Method definition

def list_dataset_export_jobs(
    self,
    *,
    datasetArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetExportJobsResponseTypeDef:  # (1)
    ...

1. See ListDatasetExportJobsResponseTypeDef

Usage example with kwargs

kwargs: ListDatasetExportJobsRequestRequestTypeDef = {  # (1)
    "datasetArn": ...,
}

parent.list_dataset_export_jobs(**kwargs)

1. See ListDatasetExportJobsRequestRequestTypeDef

list_dataset_groups

Returns a list of dataset groups.

Type annotations and code completion for boto3.client("personalize").list_dataset_groups method. boto3 documentation

Method definition

def list_dataset_groups(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetGroupsResponseTypeDef:  # (1)
    ...

1. See ListDatasetGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListDatasetGroupsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_dataset_groups(**kwargs)

1. See ListDatasetGroupsRequestRequestTypeDef

list_dataset_import_jobs

Returns a list of dataset import jobs that use the given dataset.

Type annotations and code completion for boto3.client("personalize").list_dataset_import_jobs method. boto3 documentation

Method definition

def list_dataset_import_jobs(
    self,
    *,
    datasetArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetImportJobsResponseTypeDef:  # (1)
    ...

1. See ListDatasetImportJobsResponseTypeDef

Usage example with kwargs

kwargs: ListDatasetImportJobsRequestRequestTypeDef = {  # (1)
    "datasetArn": ...,
}

parent.list_dataset_import_jobs(**kwargs)

1. See ListDatasetImportJobsRequestRequestTypeDef

list_datasets

Returns the list of datasets contained in the given dataset group.

Type annotations and code completion for boto3.client("personalize").list_datasets method. boto3 documentation

Method definition

def list_datasets(
    self,
    *,
    datasetGroupArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetsResponseTypeDef:  # (1)
    ...

1. See ListDatasetsResponseTypeDef

Usage example with kwargs

kwargs: ListDatasetsRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.list_datasets(**kwargs)

1. See ListDatasetsRequestRequestTypeDef

list_event_trackers

Returns the list of event trackers associated with the account.

Type annotations and code completion for boto3.client("personalize").list_event_trackers method. boto3 documentation

Method definition

def list_event_trackers(
    self,
    *,
    datasetGroupArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEventTrackersResponseTypeDef:  # (1)
    ...

1. See ListEventTrackersResponseTypeDef

Usage example with kwargs

kwargs: ListEventTrackersRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.list_event_trackers(**kwargs)

1. See ListEventTrackersRequestRequestTypeDef

list_filters

Lists all filters that belong to a given dataset group.

Type annotations and code completion for boto3.client("personalize").list_filters method. boto3 documentation

Method definition

def list_filters(
    self,
    *,
    datasetGroupArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListFiltersResponseTypeDef:  # (1)
    ...

1. See ListFiltersResponseTypeDef

Usage example with kwargs

kwargs: ListFiltersRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.list_filters(**kwargs)

1. See ListFiltersRequestRequestTypeDef

list_metric_attribution_metrics

Lists the metrics for the metric attribution.

Type annotations and code completion for boto3.client("personalize").list_metric_attribution_metrics method. boto3 documentation

Method definition

def list_metric_attribution_metrics(
    self,
    *,
    metricAttributionArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMetricAttributionMetricsResponseTypeDef:  # (1)
    ...

1. See ListMetricAttributionMetricsResponseTypeDef

Usage example with kwargs

kwargs: ListMetricAttributionMetricsRequestRequestTypeDef = {  # (1)
    "metricAttributionArn": ...,
}

parent.list_metric_attribution_metrics(**kwargs)

1. See ListMetricAttributionMetricsRequestRequestTypeDef

list_metric_attributions

Lists metric attributions.

Type annotations and code completion for boto3.client("personalize").list_metric_attributions method. boto3 documentation

Method definition

def list_metric_attributions(
    self,
    *,
    datasetGroupArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMetricAttributionsResponseTypeDef:  # (1)
    ...

1. See ListMetricAttributionsResponseTypeDef

Usage example with kwargs

kwargs: ListMetricAttributionsRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.list_metric_attributions(**kwargs)

1. See ListMetricAttributionsRequestRequestTypeDef

list_recipes

Returns a list of available recipes.

Type annotations and code completion for boto3.client("personalize").list_recipes method. boto3 documentation

Method definition

def list_recipes(
    self,
    *,
    recipeProvider: RecipeProviderType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    domain: DomainType = ...,  # (2)
) -> ListRecipesResponseTypeDef:  # (3)
    ...

1. See RecipeProviderType
2. See DomainType
3. See ListRecipesResponseTypeDef

Usage example with kwargs

kwargs: ListRecipesRequestRequestTypeDef = {  # (1)
    "recipeProvider": ...,
}

parent.list_recipes(**kwargs)

1. See ListRecipesRequestRequestTypeDef

list_recommenders

Returns a list of recommenders in a given Domain dataset group.

Type annotations and code completion for boto3.client("personalize").list_recommenders method. boto3 documentation

Method definition

def list_recommenders(
    self,
    *,
    datasetGroupArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListRecommendersResponseTypeDef:  # (1)
    ...

1. See ListRecommendersResponseTypeDef

Usage example with kwargs

kwargs: ListRecommendersRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.list_recommenders(**kwargs)

1. See ListRecommendersRequestRequestTypeDef

list_schemas

Returns the list of schemas associated with the account.

Type annotations and code completion for boto3.client("personalize").list_schemas method. boto3 documentation

Method definition

def list_schemas(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSchemasResponseTypeDef:  # (1)
    ...

1. See ListSchemasResponseTypeDef

Usage example with kwargs

kwargs: ListSchemasRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_schemas(**kwargs)

1. See ListSchemasRequestRequestTypeDef

list_solution_versions

Returns a list of solution versions for the given solution.

Type annotations and code completion for boto3.client("personalize").list_solution_versions method. boto3 documentation

Method definition

def list_solution_versions(
    self,
    *,
    solutionArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSolutionVersionsResponseTypeDef:  # (1)
    ...

1. See ListSolutionVersionsResponseTypeDef

Usage example with kwargs

kwargs: ListSolutionVersionsRequestRequestTypeDef = {  # (1)
    "solutionArn": ...,
}

parent.list_solution_versions(**kwargs)

1. See ListSolutionVersionsRequestRequestTypeDef

list_solutions

Returns a list of solutions that use the given dataset group.

Type annotations and code completion for boto3.client("personalize").list_solutions method. boto3 documentation

Method definition

def list_solutions(
    self,
    *,
    datasetGroupArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSolutionsResponseTypeDef:  # (1)
    ...

1. See ListSolutionsResponseTypeDef

Usage example with kwargs

kwargs: ListSolutionsRequestRequestTypeDef = {  # (1)
    "datasetGroupArn": ...,
}

parent.list_solutions(**kwargs)

1. See ListSolutionsRequestRequestTypeDef

list_tags_for_resource

Get a list of tags_ attached to a resource.

Type annotations and code completion for boto3.client("personalize").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

start_recommender

Starts a recommender that is INACTIVE.

Type annotations and code completion for boto3.client("personalize").start_recommender method. boto3 documentation

Method definition

def start_recommender(
    self,
    *,
    recommenderArn: str,
) -> StartRecommenderResponseTypeDef:  # (1)
    ...

1. See StartRecommenderResponseTypeDef

Usage example with kwargs

kwargs: StartRecommenderRequestRequestTypeDef = {  # (1)
    "recommenderArn": ...,
}

parent.start_recommender(**kwargs)

1. See StartRecommenderRequestRequestTypeDef

stop_recommender

Stops a recommender that is ACTIVE.

Type annotations and code completion for boto3.client("personalize").stop_recommender method. boto3 documentation

Method definition

def stop_recommender(
    self,
    *,
    recommenderArn: str,
) -> StopRecommenderResponseTypeDef:  # (1)
    ...

1. See StopRecommenderResponseTypeDef

Usage example with kwargs

kwargs: StopRecommenderRequestRequestTypeDef = {  # (1)
    "recommenderArn": ...,
}

parent.stop_recommender(**kwargs)

1. See StopRecommenderRequestRequestTypeDef

stop_solution_version_creation

Stops creating a solution version that is in a state of CREATE_PENDING or CREATE IN_PROGRESS.

Type annotations and code completion for boto3.client("personalize").stop_solution_version_creation method. boto3 documentation

Method definition

def stop_solution_version_creation(
    self,
    *,
    solutionVersionArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: StopSolutionVersionCreationRequestRequestTypeDef = {  # (1)
    "solutionVersionArn": ...,
}

parent.stop_solution_version_creation(**kwargs)

1. See StopSolutionVersionCreationRequestRequestTypeDef

tag_resource

Add a list of tags to a resource.

Type annotations and code completion for boto3.client("personalize").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Remove tags_ that are attached to a resource.

Type annotations and code completion for boto3.client("personalize").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_campaign

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

Type annotations and code completion for boto3.client("personalize").update_campaign method. boto3 documentation

Method definition

def update_campaign(
    self,
    *,
    campaignArn: str,
    solutionVersionArn: str = ...,
    minProvisionedTPS: int = ...,
    campaignConfig: CampaignConfigTypeDef = ...,  # (1)
) -> UpdateCampaignResponseTypeDef:  # (2)
    ...

1. See CampaignConfigTypeDef
2. See UpdateCampaignResponseTypeDef

Usage example with kwargs

kwargs: UpdateCampaignRequestRequestTypeDef = {  # (1)
    "campaignArn": ...,
}

parent.update_campaign(**kwargs)

1. See UpdateCampaignRequestRequestTypeDef

update_metric_attribution

Updates a metric attribution.

Type annotations and code completion for boto3.client("personalize").update_metric_attribution method. boto3 documentation

Method definition

def update_metric_attribution(
    self,
    *,
    addMetrics: Sequence[MetricAttributeTypeDef] = ...,  # (1)
    removeMetrics: Sequence[str] = ...,
    metricsOutputConfig: MetricAttributionOutputTypeDef = ...,  # (2)
    metricAttributionArn: str = ...,
) -> UpdateMetricAttributionResponseTypeDef:  # (3)
    ...

1. See MetricAttributeTypeDef
2. See MetricAttributionOutputTypeDef
3. See UpdateMetricAttributionResponseTypeDef

Usage example with kwargs

kwargs: UpdateMetricAttributionRequestRequestTypeDef = {  # (1)
    "addMetrics": ...,
}

parent.update_metric_attribution(**kwargs)

1. See UpdateMetricAttributionRequestRequestTypeDef

update_recommender

Updates the recommender to modify the recommender configuration.

Type annotations and code completion for boto3.client("personalize").update_recommender method. boto3 documentation

Method definition

def update_recommender(
    self,
    *,
    recommenderArn: str,
    recommenderConfig: RecommenderConfigTypeDef,  # (1)
) -> UpdateRecommenderResponseTypeDef:  # (2)
    ...

1. See RecommenderConfigTypeDef
2. See UpdateRecommenderResponseTypeDef

Usage example with kwargs

kwargs: UpdateRecommenderRequestRequestTypeDef = {  # (1)
    "recommenderArn": ...,
    "recommenderConfig": ...,
}

parent.update_recommender(**kwargs)

1. See UpdateRecommenderRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("personalize").get_paginator method with overloads.

• client.get_paginator("list_batch_inference_jobs") -> ListBatchInferenceJobsPaginator
• client.get_paginator("list_batch_segment_jobs") -> ListBatchSegmentJobsPaginator
• client.get_paginator("list_campaigns") -> ListCampaignsPaginator
• client.get_paginator("list_dataset_export_jobs") -> ListDatasetExportJobsPaginator
• client.get_paginator("list_dataset_groups") -> ListDatasetGroupsPaginator
• client.get_paginator("list_dataset_import_jobs") -> ListDatasetImportJobsPaginator
• client.get_paginator("list_datasets") -> ListDatasetsPaginator
• client.get_paginator("list_event_trackers") -> ListEventTrackersPaginator
• client.get_paginator("list_filters") -> ListFiltersPaginator
• client.get_paginator("list_metric_attribution_metrics") -> ListMetricAttributionMetricsPaginator
• client.get_paginator("list_metric_attributions") -> ListMetricAttributionsPaginator
• client.get_paginator("list_recipes") -> ListRecipesPaginator
• client.get_paginator("list_recommenders") -> ListRecommendersPaginator
• client.get_paginator("list_schemas") -> ListSchemasPaginator
• client.get_paginator("list_solution_versions") -> ListSolutionVersionsPaginator
• client.get_paginator("list_solutions") -> ListSolutionsPaginator