CancelTrainedModel

$result = $client->cancelTrainedModel([/* ... */]);
$promise = $client->cancelTrainedModelAsync([/* ... */]);

Submits a request to cancel the trained model job.

Parameter Syntax

$result = $client->cancelTrainedModel([
    'membershipIdentifier' => '<string>', // REQUIRED
    'trainedModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

CancelTrainedModelInferenceJob

$result = $client->cancelTrainedModelInferenceJob([/* ... */]);
$promise = $client->cancelTrainedModelInferenceJobAsync([/* ... */]);

Submits a request to cancel a trained model inference job.

Parameter Syntax

$result = $client->cancelTrainedModelInferenceJob([
    'membershipIdentifier' => '<string>', // REQUIRED
    'trainedModelInferenceJobArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

CreateAudienceModel

$result = $client->createAudienceModel([/* ... */]);
$promise = $client->createAudienceModelAsync([/* ... */]);

Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

Parameter Syntax

$result = $client->createAudienceModel([
    'description' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'trainingDataEndTime' => <integer || string || DateTime>,
    'trainingDataStartTime' => <integer || string || DateTime>,
    'trainingDatasetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'audienceModelArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ServiceQuotaExceededException:

You have exceeded your service quota.

CreateConfiguredAudienceModel

$result = $client->createConfiguredAudienceModel([/* ... */]);
$promise = $client->createConfiguredAudienceModelAsync([/* ... */]);

Defines the information necessary to create a configured audience model.

Parameter Syntax

$result = $client->createConfiguredAudienceModel([
    'audienceModelArn' => '<string>', // REQUIRED
    'audienceSizeConfig' => [
        'audienceSizeBins' => [<integer>, ...], // REQUIRED
        'audienceSizeType' => 'ABSOLUTE|PERCENTAGE', // REQUIRED
    ],
    'childResourceTagOnCreatePolicy' => 'FROM_PARENT_RESOURCE|NONE',
    'description' => '<string>',
    'minMatchingSeedSize' => <integer>,
    'name' => '<string>', // REQUIRED
    'outputConfig' => [ // REQUIRED
        'destination' => [ // REQUIRED
            's3Destination' => [ // REQUIRED
                's3Uri' => '<string>', // REQUIRED
            ],
        ],
        'roleArn' => '<string>', // REQUIRED
    ],
    'sharedAudienceMetrics' => ['<string>', ...], // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModelArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ServiceQuotaExceededException:

You have exceeded your service quota.

CreateConfiguredModelAlgorithm

$result = $client->createConfiguredModelAlgorithm([/* ... */]);
$promise = $client->createConfiguredModelAlgorithmAsync([/* ... */]);

Creates a configured model algorithm using a container image stored in an ECR repository.

Parameter Syntax

$result = $client->createConfiguredModelAlgorithm([
    'description' => '<string>',
    'inferenceContainerConfig' => [
        'imageUri' => '<string>', // REQUIRED
    ],
    'kmsKeyArn' => '<string>',
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'trainingContainerConfig' => [
        'arguments' => ['<string>', ...],
        'entrypoint' => ['<string>', ...],
        'imageUri' => '<string>', // REQUIRED
        'metricDefinitions' => [
            [
                'name' => '<string>', // REQUIRED
                'regex' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'configuredModelAlgorithmArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

You have exceeded your service quota.

CreateConfiguredModelAlgorithmAssociation

$result = $client->createConfiguredModelAlgorithmAssociation([/* ... */]);
$promise = $client->createConfiguredModelAlgorithmAssociationAsync([/* ... */]);

Associates a configured model algorithm to a collaboration for use by any member of the collaboration.

Parameter Syntax

$result = $client->createConfiguredModelAlgorithmAssociation([
    'configuredModelAlgorithmArn' => '<string>', // REQUIRED
    'description' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'privacyConfiguration' => [
        'policies' => [ // REQUIRED
            'trainedModelExports' => [
                'filesToExport' => ['<string>', ...], // REQUIRED
                'maxSize' => [ // REQUIRED
                    'unit' => 'GB', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
            ],
            'trainedModelInferenceJobs' => [
                'containerLogs' => [
                    [
                        'allowedAccountIds' => ['<string>', ...], // REQUIRED
                        'filterPattern' => '<string>',
                    ],
                    // ...
                ],
                'maxOutputSize' => [
                    'unit' => 'GB', // REQUIRED
                    'value' => <float>, // REQUIRED
                ],
            ],
            'trainedModels' => [
                'containerLogs' => [
                    [
                        'allowedAccountIds' => ['<string>', ...], // REQUIRED
                        'filterPattern' => '<string>',
                    ],
                    // ...
                ],
                'containerMetrics' => [
                    'noiseLevel' => 'HIGH|MEDIUM|LOW|NONE', // REQUIRED
                ],
            ],
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'configuredModelAlgorithmAssociationArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ServiceQuotaExceededException:

You have exceeded your service quota.

CreateMLInputChannel

$result = $client->createMLInputChannel([/* ... */]);
$promise = $client->createMLInputChannelAsync([/* ... */]);

Provides the information to create an ML input channel. An ML input channel is the result of a query that can be used for ML modeling.

Parameter Syntax

$result = $client->createMLInputChannel([
    'configuredModelAlgorithmAssociations' => ['<string>', ...], // REQUIRED
    'description' => '<string>',
    'inputChannel' => [ // REQUIRED
        'dataSource' => [ // REQUIRED
            'protectedQueryInputParameters' => [
                'computeConfiguration' => [
                    'worker' => [
                        'number' => <integer>,
                        'type' => 'CR.1X|CR.4X',
                    ],
                ],
                'sqlParameters' => [ // REQUIRED
                    'analysisTemplateArn' => '<string>',
                    'parameters' => ['<string>', ...],
                    'queryString' => '<string>',
                ],
            ],
        ],
        'roleArn' => '<string>', // REQUIRED
    ],
    'kmsKeyArn' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'retentionInDays' => <integer>, // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'mlInputChannelArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ServiceQuotaExceededException:

You have exceeded your service quota.

CreateTrainedModel

$result = $client->createTrainedModel([/* ... */]);
$promise = $client->createTrainedModelAsync([/* ... */]);

Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.

Parameter Syntax

$result = $client->createTrainedModel([
    'configuredModelAlgorithmAssociationArn' => '<string>', // REQUIRED
    'dataChannels' => [ // REQUIRED
        [
            'channelName' => '<string>', // REQUIRED
            'mlInputChannelArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'description' => '<string>',
    'environment' => ['<string>', ...],
    'hyperparameters' => ['<string>', ...],
    'kmsKeyArn' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'resourceConfig' => [ // REQUIRED
        'instanceCount' => <integer>,
        'instanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge', // REQUIRED
        'volumeSizeInGB' => <integer>, // REQUIRED
    ],
    'stoppingCondition' => [
        'maxRuntimeInSeconds' => <integer>,
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'trainedModelArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ServiceQuotaExceededException:

You have exceeded your service quota.

CreateTrainingDataset

$result = $client->createTrainingDataset([/* ... */]);
$promise = $client->createTrainingDatasetAsync([/* ... */]);

Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

Parameter Syntax

$result = $client->createTrainingDataset([
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'roleArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'trainingData' => [ // REQUIRED
        [
            'inputConfig' => [ // REQUIRED
                'dataSource' => [ // REQUIRED
                    'glueDataSource' => [ // REQUIRED
                        'catalogId' => '<string>',
                        'databaseName' => '<string>', // REQUIRED
                        'tableName' => '<string>', // REQUIRED
                    ],
                ],
                'schema' => [ // REQUIRED
                    [
                        'columnName' => '<string>', // REQUIRED
                        'columnTypes' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
            ],
            'type' => 'INTERACTIONS', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'trainingDatasetArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteAudienceGenerationJob

$result = $client->deleteAudienceGenerationJob([/* ... */]);
$promise = $client->deleteAudienceGenerationJobAsync([/* ... */]);

Deletes the specified audience generation job, and removes all data associated with the job.

Parameter Syntax

$result = $client->deleteAudienceGenerationJob([
    'audienceGenerationJobArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteAudienceModel

$result = $client->deleteAudienceModel([/* ... */]);
$promise = $client->deleteAudienceModelAsync([/* ... */]);

Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.

Parameter Syntax

$result = $client->deleteAudienceModel([
    'audienceModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteConfiguredAudienceModel

$result = $client->deleteConfiguredAudienceModel([/* ... */]);
$promise = $client->deleteConfiguredAudienceModelAsync([/* ... */]);

Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

Parameter Syntax

$result = $client->deleteConfiguredAudienceModel([
    'configuredAudienceModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteConfiguredAudienceModelPolicy

$result = $client->deleteConfiguredAudienceModelPolicy([/* ... */]);
$promise = $client->deleteConfiguredAudienceModelPolicyAsync([/* ... */]);

Deletes the specified configured audience model policy.

Parameter Syntax

$result = $client->deleteConfiguredAudienceModelPolicy([
    'configuredAudienceModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteConfiguredModelAlgorithm

$result = $client->deleteConfiguredModelAlgorithm([/* ... */]);
$promise = $client->deleteConfiguredModelAlgorithmAsync([/* ... */]);

Deletes a configured model algorithm.

Parameter Syntax

$result = $client->deleteConfiguredModelAlgorithm([
    'configuredModelAlgorithmArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteConfiguredModelAlgorithmAssociation

$result = $client->deleteConfiguredModelAlgorithmAssociation([/* ... */]);
$promise = $client->deleteConfiguredModelAlgorithmAssociationAsync([/* ... */]);

Deletes a configured model algorithm association.

Parameter Syntax

$result = $client->deleteConfiguredModelAlgorithmAssociation([
    'configuredModelAlgorithmAssociationArn' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteMLConfiguration

$result = $client->deleteMLConfiguration([/* ... */]);
$promise = $client->deleteMLConfigurationAsync([/* ... */]);

Deletes a ML modeling configuration.

Parameter Syntax

$result = $client->deleteMLConfiguration([
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteMLInputChannelData

$result = $client->deleteMLInputChannelData([/* ... */]);
$promise = $client->deleteMLInputChannelDataAsync([/* ... */]);

Provides the information necessary to delete an ML input channel.

Parameter Syntax

$result = $client->deleteMLInputChannelData([
    'membershipIdentifier' => '<string>', // REQUIRED
    'mlInputChannelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteTrainedModelOutput

$result = $client->deleteTrainedModelOutput([/* ... */]);
$promise = $client->deleteTrainedModelOutputAsync([/* ... */]);

Deletes the output of a trained model.

Parameter Syntax

$result = $client->deleteTrainedModelOutput([
    'membershipIdentifier' => '<string>', // REQUIRED
    'trainedModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

DeleteTrainingDataset

$result = $client->deleteTrainingDataset([/* ... */]);
$promise = $client->deleteTrainingDatasetAsync([/* ... */]);

Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.

Parameter Syntax

$result = $client->deleteTrainingDataset([
    'trainingDatasetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetAudienceGenerationJob

$result = $client->getAudienceGenerationJob([/* ... */]);
$promise = $client->getAudienceGenerationJobAsync([/* ... */]);

Returns information about an audience generation job.

Parameter Syntax

$result = $client->getAudienceGenerationJob([
    'audienceGenerationJobArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'audienceGenerationJobArn' => '<string>',
    'collaborationId' => '<string>',
    'configuredAudienceModelArn' => '<string>',
    'createTime' => <DateTime>,
    'description' => '<string>',
    'includeSeedInOutput' => true || false,
    'metrics' => [
        'recallMetric' => <float>,
        'relevanceMetrics' => [
            [
                'audienceSize' => [
                    'type' => 'ABSOLUTE|PERCENTAGE',
                    'value' => <integer>,
                ],
                'score' => <float>,
            ],
            // ...
        ],
    ],
    'name' => '<string>',
    'protectedQueryIdentifier' => '<string>',
    'seedAudience' => [
        'dataSource' => [
            's3Uri' => '<string>',
        ],
        'roleArn' => '<string>',
        'sqlParameters' => [
            'analysisTemplateArn' => '<string>',
            'parameters' => ['<string>', ...],
            'queryString' => '<string>',
        ],
    ],
    'startedBy' => '<string>',
    'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED',
    'statusDetails' => [
        'message' => '<string>',
        'statusCode' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetAudienceModel

$result = $client->getAudienceModel([/* ... */]);
$promise = $client->getAudienceModelAsync([/* ... */]);

Returns information about an audience model

Parameter Syntax

$result = $client->getAudienceModel([
    'audienceModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'audienceModelArn' => '<string>',
    'createTime' => <DateTime>,
    'description' => '<string>',
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED',
    'statusDetails' => [
        'message' => '<string>',
        'statusCode' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'trainingDataEndTime' => <DateTime>,
    'trainingDataStartTime' => <DateTime>,
    'trainingDatasetArn' => '<string>',
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetCollaborationConfiguredModelAlgorithmAssociation

$result = $client->getCollaborationConfiguredModelAlgorithmAssociation([/* ... */]);
$promise = $client->getCollaborationConfiguredModelAlgorithmAssociationAsync([/* ... */]);

Returns information about the configured model algorithm association in a collaboration.

Parameter Syntax

$result = $client->getCollaborationConfiguredModelAlgorithmAssociation([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'configuredModelAlgorithmAssociationArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationIdentifier' => '<string>',
    'configuredModelAlgorithmArn' => '<string>',
    'configuredModelAlgorithmAssociationArn' => '<string>',
    'createTime' => <DateTime>,
    'creatorAccountId' => '<string>',
    'description' => '<string>',
    'membershipIdentifier' => '<string>',
    'name' => '<string>',
    'privacyConfiguration' => [
        'policies' => [
            'trainedModelExports' => [
                'filesToExport' => ['<string>', ...],
                'maxSize' => [
                    'unit' => 'GB',
                    'value' => <float>,
                ],
            ],
            'trainedModelInferenceJobs' => [
                'containerLogs' => [
                    [
                        'allowedAccountIds' => ['<string>', ...],
                        'filterPattern' => '<string>',
                    ],
                    // ...
                ],
                'maxOutputSize' => [
                    'unit' => 'GB',
                    'value' => <float>,
                ],
            ],
            'trainedModels' => [
                'containerLogs' => [
                    [
                        'allowedAccountIds' => ['<string>', ...],
                        'filterPattern' => '<string>',
                    ],
                    // ...
                ],
                'containerMetrics' => [
                    'noiseLevel' => 'HIGH|MEDIUM|LOW|NONE',
                ],
            ],
        ],
    ],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetCollaborationMLInputChannel

$result = $client->getCollaborationMLInputChannel([/* ... */]);
$promise = $client->getCollaborationMLInputChannelAsync([/* ... */]);

Returns information about a specific ML input channel in a collaboration.

Parameter Syntax

$result = $client->getCollaborationMLInputChannel([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'mlInputChannelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationIdentifier' => '<string>',
    'configuredModelAlgorithmAssociations' => ['<string>', ...],
    'createTime' => <DateTime>,
    'creatorAccountId' => '<string>',
    'description' => '<string>',
    'membershipIdentifier' => '<string>',
    'mlInputChannelArn' => '<string>',
    'name' => '<string>',
    'numberOfRecords' => <integer>,
    'retentionInDays' => <integer>,
    'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE',
    'statusDetails' => [
        'message' => '<string>',
        'statusCode' => '<string>',
    ],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetCollaborationTrainedModel

$result = $client->getCollaborationTrainedModel([/* ... */]);
$promise = $client->getCollaborationTrainedModelAsync([/* ... */]);

Returns information about a trained model in a collaboration.

Parameter Syntax

$result = $client->getCollaborationTrainedModel([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'trainedModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationIdentifier' => '<string>',
    'configuredModelAlgorithmAssociationArn' => '<string>',
    'createTime' => <DateTime>,
    'creatorAccountId' => '<string>',
    'description' => '<string>',
    'logsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
    'logsStatusDetails' => '<string>',
    'membershipIdentifier' => '<string>',
    'metricsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
    'metricsStatusDetails' => '<string>',
    'name' => '<string>',
    'resourceConfig' => [
        'instanceCount' => <integer>,
        'instanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge',
        'volumeSizeInGB' => <integer>,
    ],
    'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE|CANCEL_PENDING|CANCEL_IN_PROGRESS|CANCEL_FAILED',
    'statusDetails' => [
        'message' => '<string>',
        'statusCode' => '<string>',
    ],
    'stoppingCondition' => [
        'maxRuntimeInSeconds' => <integer>,
    ],
    'trainedModelArn' => '<string>',
    'trainingContainerImageDigest' => '<string>',
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetConfiguredAudienceModel

$result = $client->getConfiguredAudienceModel([/* ... */]);
$promise = $client->getConfiguredAudienceModelAsync([/* ... */]);

Returns information about a specified configured audience model.

Parameter Syntax

$result = $client->getConfiguredAudienceModel([
    'configuredAudienceModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'audienceModelArn' => '<string>',
    'audienceSizeConfig' => [
        'audienceSizeBins' => [<integer>, ...],
        'audienceSizeType' => 'ABSOLUTE|PERCENTAGE',
    ],
    'childResourceTagOnCreatePolicy' => 'FROM_PARENT_RESOURCE|NONE',
    'configuredAudienceModelArn' => '<string>',
    'createTime' => <DateTime>,
    'description' => '<string>',
    'minMatchingSeedSize' => <integer>,
    'name' => '<string>',
    'outputConfig' => [
        'destination' => [
            's3Destination' => [
                's3Uri' => '<string>',
            ],
        ],
        'roleArn' => '<string>',
    ],
    'sharedAudienceMetrics' => ['<string>', ...],
    'status' => 'ACTIVE',
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetConfiguredAudienceModelPolicy

$result = $client->getConfiguredAudienceModelPolicy([/* ... */]);
$promise = $client->getConfiguredAudienceModelPolicyAsync([/* ... */]);

Returns information about a configured audience model policy.

Parameter Syntax

$result = $client->getConfiguredAudienceModelPolicy([
    'configuredAudienceModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModelArn' => '<string>',
    'configuredAudienceModelPolicy' => '<string>',
    'policyHash' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetConfiguredModelAlgorithm

$result = $client->getConfiguredModelAlgorithm([/* ... */]);
$promise = $client->getConfiguredModelAlgorithmAsync([/* ... */]);

Returns information about a configured model algorithm.

Parameter Syntax

$result = $client->getConfiguredModelAlgorithm([
    'configuredModelAlgorithmArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuredModelAlgorithmArn' => '<string>',
    'createTime' => <DateTime>,
    'description' => '<string>',
    'inferenceContainerConfig' => [
        'imageUri' => '<string>',
    ],
    'kmsKeyArn' => '<string>',
    'name' => '<string>',
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
    'trainingContainerConfig' => [
        'arguments' => ['<string>', ...],
        'entrypoint' => ['<string>', ...],
        'imageUri' => '<string>',
        'metricDefinitions' => [
            [
                'name' => '<string>',
                'regex' => '<string>',
            ],
            // ...
        ],
    ],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetConfiguredModelAlgorithmAssociation

$result = $client->getConfiguredModelAlgorithmAssociation([/* ... */]);
$promise = $client->getConfiguredModelAlgorithmAssociationAsync([/* ... */]);

Returns information about a configured model algorithm association.

Parameter Syntax

$result = $client->getConfiguredModelAlgorithmAssociation([
    'configuredModelAlgorithmAssociationArn' => '<string>', // REQUIRED
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationIdentifier' => '<string>',
    'configuredModelAlgorithmArn' => '<string>',
    'configuredModelAlgorithmAssociationArn' => '<string>',
    'createTime' => <DateTime>,
    'description' => '<string>',
    'membershipIdentifier' => '<string>',
    'name' => '<string>',
    'privacyConfiguration' => [
        'policies' => [
            'trainedModelExports' => [
                'filesToExport' => ['<string>', ...],
                'maxSize' => [
                    'unit' => 'GB',
                    'value' => <float>,
                ],
            ],
            'trainedModelInferenceJobs' => [
                'containerLogs' => [
                    [
                        'allowedAccountIds' => ['<string>', ...],
                        'filterPattern' => '<string>',
                    ],
                    // ...
                ],
                'maxOutputSize' => [
                    'unit' => 'GB',
                    'value' => <float>,
                ],
            ],
            'trainedModels' => [
                'containerLogs' => [
                    [
                        'allowedAccountIds' => ['<string>', ...],
                        'filterPattern' => '<string>',
                    ],
                    // ...
                ],
                'containerMetrics' => [
                    'noiseLevel' => 'HIGH|MEDIUM|LOW|NONE',
                ],
            ],
        ],
    ],
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetMLConfiguration

$result = $client->getMLConfiguration([/* ... */]);
$promise = $client->getMLConfigurationAsync([/* ... */]);

Returns information about a specific ML configuration.

Parameter Syntax

$result = $client->getMLConfiguration([
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createTime' => <DateTime>,
    'defaultOutputLocation' => [
        'destination' => [
            's3Destination' => [
                's3Uri' => '<string>',
            ],
        ],
        'roleArn' => '<string>',
    ],
    'membershipIdentifier' => '<string>',
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetMLInputChannel

$result = $client->getMLInputChannel([/* ... */]);
$promise = $client->getMLInputChannelAsync([/* ... */]);

Returns information about an ML input channel.

Parameter Syntax

$result = $client->getMLInputChannel([
    'membershipIdentifier' => '<string>', // REQUIRED
    'mlInputChannelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationIdentifier' => '<string>',
    'configuredModelAlgorithmAssociations' => ['<string>', ...],
    'createTime' => <DateTime>,
    'description' => '<string>',
    'inputChannel' => [
        'dataSource' => [
            'protectedQueryInputParameters' => [
                'computeConfiguration' => [
                    'worker' => [
                        'number' => <integer>,
                        'type' => 'CR.1X|CR.4X',
                    ],
                ],
                'sqlParameters' => [
                    'analysisTemplateArn' => '<string>',
                    'parameters' => ['<string>', ...],
                    'queryString' => '<string>',
                ],
            ],
        ],
        'roleArn' => '<string>',
    ],
    'kmsKeyArn' => '<string>',
    'membershipIdentifier' => '<string>',
    'mlInputChannelArn' => '<string>',
    'name' => '<string>',
    'numberOfFiles' => <float>,
    'numberOfRecords' => <integer>,
    'protectedQueryIdentifier' => '<string>',
    'retentionInDays' => <integer>,
    'sizeInGb' => <float>,
    'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE',
    'statusDetails' => [
        'message' => '<string>',
        'statusCode' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetTrainedModel

$result = $client->getTrainedModel([/* ... */]);
$promise = $client->getTrainedModelAsync([/* ... */]);

Returns information about a trained model.

Parameter Syntax

$result = $client->getTrainedModel([
    'membershipIdentifier' => '<string>', // REQUIRED
    'trainedModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationIdentifier' => '<string>',
    'configuredModelAlgorithmAssociationArn' => '<string>',
    'createTime' => <DateTime>,
    'dataChannels' => [
        [
            'channelName' => '<string>',
            'mlInputChannelArn' => '<string>',
        ],
        // ...
    ],
    'description' => '<string>',
    'environment' => ['<string>', ...],
    'hyperparameters' => ['<string>', ...],
    'kmsKeyArn' => '<string>',
    'logsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
    'logsStatusDetails' => '<string>',
    'membershipIdentifier' => '<string>',
    'metricsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
    'metricsStatusDetails' => '<string>',
    'name' => '<string>',
    'resourceConfig' => [
        'instanceCount' => <integer>,
        'instanceType' => 'ml.m4.xlarge|ml.m4.2xlarge|ml.m4.4xlarge|ml.m4.10xlarge|ml.m4.16xlarge|ml.g4dn.xlarge|ml.g4dn.2xlarge|ml.g4dn.4xlarge|ml.g4dn.8xlarge|ml.g4dn.12xlarge|ml.g4dn.16xlarge|ml.m5.large|ml.m5.xlarge|ml.m5.2xlarge|ml.m5.4xlarge|ml.m5.12xlarge|ml.m5.24xlarge|ml.c4.xlarge|ml.c4.2xlarge|ml.c4.4xlarge|ml.c4.8xlarge|ml.p2.xlarge|ml.p2.8xlarge|ml.p2.16xlarge|ml.p3.2xlarge|ml.p3.8xlarge|ml.p3.16xlarge|ml.p3dn.24xlarge|ml.p4d.24xlarge|ml.p4de.24xlarge|ml.p5.48xlarge|ml.c5.xlarge|ml.c5.2xlarge|ml.c5.4xlarge|ml.c5.9xlarge|ml.c5.18xlarge|ml.c5n.xlarge|ml.c5n.2xlarge|ml.c5n.4xlarge|ml.c5n.9xlarge|ml.c5n.18xlarge|ml.g5.xlarge|ml.g5.2xlarge|ml.g5.4xlarge|ml.g5.8xlarge|ml.g5.16xlarge|ml.g5.12xlarge|ml.g5.24xlarge|ml.g5.48xlarge|ml.trn1.2xlarge|ml.trn1.32xlarge|ml.trn1n.32xlarge|ml.m6i.large|ml.m6i.xlarge|ml.m6i.2xlarge|ml.m6i.4xlarge|ml.m6i.8xlarge|ml.m6i.12xlarge|ml.m6i.16xlarge|ml.m6i.24xlarge|ml.m6i.32xlarge|ml.c6i.xlarge|ml.c6i.2xlarge|ml.c6i.8xlarge|ml.c6i.4xlarge|ml.c6i.12xlarge|ml.c6i.16xlarge|ml.c6i.24xlarge|ml.c6i.32xlarge|ml.r5d.large|ml.r5d.xlarge|ml.r5d.2xlarge|ml.r5d.4xlarge|ml.r5d.8xlarge|ml.r5d.12xlarge|ml.r5d.16xlarge|ml.r5d.24xlarge|ml.t3.medium|ml.t3.large|ml.t3.xlarge|ml.t3.2xlarge|ml.r5.large|ml.r5.xlarge|ml.r5.2xlarge|ml.r5.4xlarge|ml.r5.8xlarge|ml.r5.12xlarge|ml.r5.16xlarge|ml.r5.24xlarge',
        'volumeSizeInGB' => <integer>,
    ],
    'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE|CANCEL_PENDING|CANCEL_IN_PROGRESS|CANCEL_FAILED',
    'statusDetails' => [
        'message' => '<string>',
        'statusCode' => '<string>',
    ],
    'stoppingCondition' => [
        'maxRuntimeInSeconds' => <integer>,
    ],
    'tags' => ['<string>', ...],
    'trainedModelArn' => '<string>',
    'trainingContainerImageDigest' => '<string>',
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetTrainedModelInferenceJob

$result = $client->getTrainedModelInferenceJob([/* ... */]);
$promise = $client->getTrainedModelInferenceJobAsync([/* ... */]);

Returns information about a trained model inference job.

Parameter Syntax

$result = $client->getTrainedModelInferenceJob([
    'membershipIdentifier' => '<string>', // REQUIRED
    'trainedModelInferenceJobArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'configuredModelAlgorithmAssociationArn' => '<string>',
    'containerExecutionParameters' => [
        'maxPayloadInMB' => <integer>,
    ],
    'createTime' => <DateTime>,
    'dataSource' => [
        'mlInputChannelArn' => '<string>',
    ],
    'description' => '<string>',
    'environment' => ['<string>', ...],
    'inferenceContainerImageDigest' => '<string>',
    'kmsKeyArn' => '<string>',
    'logsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
    'logsStatusDetails' => '<string>',
    'membershipIdentifier' => '<string>',
    'metricsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
    'metricsStatusDetails' => '<string>',
    'name' => '<string>',
    'outputConfiguration' => [
        'accept' => '<string>',
        'members' => [
            [
                'accountId' => '<string>',
            ],
            // ...
        ],
    ],
    'resourceConfig' => [
        'instanceCount' => <integer>,
        'instanceType' => 'ml.r7i.48xlarge|ml.r6i.16xlarge|ml.m6i.xlarge|ml.m5.4xlarge|ml.p2.xlarge|ml.m4.16xlarge|ml.r7i.16xlarge|ml.m7i.xlarge|ml.m6i.12xlarge|ml.r7i.8xlarge|ml.r7i.large|ml.m7i.12xlarge|ml.m6i.24xlarge|ml.m7i.24xlarge|ml.r6i.8xlarge|ml.r6i.large|ml.g5.2xlarge|ml.m5.large|ml.p3.16xlarge|ml.m7i.48xlarge|ml.m6i.16xlarge|ml.p2.16xlarge|ml.g5.4xlarge|ml.m7i.16xlarge|ml.c4.2xlarge|ml.c5.2xlarge|ml.c6i.32xlarge|ml.c4.4xlarge|ml.g5.8xlarge|ml.c6i.xlarge|ml.c5.4xlarge|ml.g4dn.xlarge|ml.c7i.xlarge|ml.c6i.12xlarge|ml.g4dn.12xlarge|ml.c7i.12xlarge|ml.c6i.24xlarge|ml.g4dn.2xlarge|ml.c7i.24xlarge|ml.c7i.2xlarge|ml.c4.8xlarge|ml.c6i.2xlarge|ml.g4dn.4xlarge|ml.c7i.48xlarge|ml.c7i.4xlarge|ml.c6i.16xlarge|ml.c5.9xlarge|ml.g4dn.16xlarge|ml.c7i.16xlarge|ml.c6i.4xlarge|ml.c5.xlarge|ml.c4.xlarge|ml.g4dn.8xlarge|ml.c7i.8xlarge|ml.c7i.large|ml.g5.xlarge|ml.c6i.8xlarge|ml.c6i.large|ml.g5.12xlarge|ml.g5.24xlarge|ml.m7i.2xlarge|ml.c5.18xlarge|ml.g5.48xlarge|ml.m6i.2xlarge|ml.g5.16xlarge|ml.m7i.4xlarge|ml.p3.2xlarge|ml.r6i.32xlarge|ml.m6i.4xlarge|ml.m5.xlarge|ml.m4.10xlarge|ml.r6i.xlarge|ml.m5.12xlarge|ml.m4.xlarge|ml.r7i.2xlarge|ml.r7i.xlarge|ml.r6i.12xlarge|ml.m5.24xlarge|ml.r7i.12xlarge|ml.m7i.8xlarge|ml.m7i.large|ml.r6i.24xlarge|ml.r6i.2xlarge|ml.m4.2xlarge|ml.r7i.24xlarge|ml.r7i.4xlarge|ml.m6i.8xlarge|ml.m6i.large|ml.m5.2xlarge|ml.p2.8xlarge|ml.r6i.4xlarge|ml.m6i.32xlarge|ml.p3.8xlarge|ml.m4.4xlarge',
    ],
    'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|CANCEL_PENDING|CANCEL_IN_PROGRESS|CANCEL_FAILED|INACTIVE',
    'statusDetails' => [
        'message' => '<string>',
        'statusCode' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'trainedModelArn' => '<string>',
    'trainedModelInferenceJobArn' => '<string>',
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

GetTrainingDataset

$result = $client->getTrainingDataset([/* ... */]);
$promise = $client->getTrainingDatasetAsync([/* ... */]);

Returns information about a training dataset.

Parameter Syntax

$result = $client->getTrainingDataset([
    'trainingDatasetArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createTime' => <DateTime>,
    'description' => '<string>',
    'name' => '<string>',
    'roleArn' => '<string>',
    'status' => 'ACTIVE',
    'tags' => ['<string>', ...],
    'trainingData' => [
        [
            'inputConfig' => [
                'dataSource' => [
                    'glueDataSource' => [
                        'catalogId' => '<string>',
                        'databaseName' => '<string>',
                        'tableName' => '<string>',
                    ],
                ],
                'schema' => [
                    [
                        'columnName' => '<string>',
                        'columnTypes' => ['<string>', ...],
                    ],
                    // ...
                ],
            ],
            'type' => 'INTERACTIONS',
        ],
        // ...
    ],
    'trainingDatasetArn' => '<string>',
    'updateTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ListAudienceExportJobs

$result = $client->listAudienceExportJobs([/* ... */]);
$promise = $client->listAudienceExportJobsAsync([/* ... */]);

Returns a list of the audience export jobs.

Parameter Syntax

$result = $client->listAudienceExportJobs([
    'audienceGenerationJobArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'audienceExportJobs' => [
        [
            'audienceGenerationJobArn' => '<string>',
            'audienceSize' => [
                'type' => 'ABSOLUTE|PERCENTAGE',
                'value' => <integer>,
            ],
            'createTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'outputLocation' => '<string>',
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE',
            'statusDetails' => [
                'message' => '<string>',
                'statusCode' => '<string>',
            ],
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListAudienceGenerationJobs

$result = $client->listAudienceGenerationJobs([/* ... */]);
$promise = $client->listAudienceGenerationJobsAsync([/* ... */]);

Returns a list of audience generation jobs.

Parameter Syntax

$result = $client->listAudienceGenerationJobs([
    'collaborationId' => '<string>',
    'configuredAudienceModelArn' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'audienceGenerationJobs' => [
        [
            'audienceGenerationJobArn' => '<string>',
            'collaborationId' => '<string>',
            'configuredAudienceModelArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'startedBy' => '<string>',
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListAudienceModels

$result = $client->listAudienceModels([/* ... */]);
$promise = $client->listAudienceModelsAsync([/* ... */]);

Returns a list of audience models.

Parameter Syntax

$result = $client->listAudienceModels([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'audienceModels' => [
        [
            'audienceModelArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED',
            'trainingDatasetArn' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListCollaborationConfiguredModelAlgorithmAssociations

$result = $client->listCollaborationConfiguredModelAlgorithmAssociations([/* ... */]);
$promise = $client->listCollaborationConfiguredModelAlgorithmAssociationsAsync([/* ... */]);

Returns a list of the configured model algorithm associations in a collaboration.

Parameter Syntax

$result = $client->listCollaborationConfiguredModelAlgorithmAssociations([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationConfiguredModelAlgorithmAssociations' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmArn' => '<string>',
            'configuredModelAlgorithmAssociationArn' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'membershipIdentifier' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListCollaborationMLInputChannels

$result = $client->listCollaborationMLInputChannels([/* ... */]);
$promise = $client->listCollaborationMLInputChannelsAsync([/* ... */]);

Returns a list of the ML input channels in a collaboration.

Parameter Syntax

$result = $client->listCollaborationMLInputChannels([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationMLInputChannelsList' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmAssociations' => ['<string>', ...],
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'membershipIdentifier' => '<string>',
            'mlInputChannelArn' => '<string>',
            'name' => '<string>',
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListCollaborationTrainedModelExportJobs

$result = $client->listCollaborationTrainedModelExportJobs([/* ... */]);
$promise = $client->listCollaborationTrainedModelExportJobsAsync([/* ... */]);

Returns a list of the export jobs for a trained model in a collaboration.

Parameter Syntax

$result = $client->listCollaborationTrainedModelExportJobs([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'trainedModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'collaborationTrainedModelExportJobs' => [
        [
            'collaborationIdentifier' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'membershipIdentifier' => '<string>',
            'name' => '<string>',
            'outputConfiguration' => [
                'members' => [
                    [
                        'accountId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE',
            'statusDetails' => [
                'message' => '<string>',
                'statusCode' => '<string>',
            ],
            'trainedModelArn' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListCollaborationTrainedModelInferenceJobs

$result = $client->listCollaborationTrainedModelInferenceJobs([/* ... */]);
$promise = $client->listCollaborationTrainedModelInferenceJobsAsync([/* ... */]);

Returns a list of trained model inference jobs in a specified collaboration.

Parameter Syntax

$result = $client->listCollaborationTrainedModelInferenceJobs([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'trainedModelArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationTrainedModelInferenceJobs' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmAssociationArn' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'logsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
            'logsStatusDetails' => '<string>',
            'membershipIdentifier' => '<string>',
            'metricsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
            'metricsStatusDetails' => '<string>',
            'name' => '<string>',
            'outputConfiguration' => [
                'accept' => '<string>',
                'members' => [
                    [
                        'accountId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|CANCEL_PENDING|CANCEL_IN_PROGRESS|CANCEL_FAILED|INACTIVE',
            'trainedModelArn' => '<string>',
            'trainedModelInferenceJobArn' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListCollaborationTrainedModels

$result = $client->listCollaborationTrainedModels([/* ... */]);
$promise = $client->listCollaborationTrainedModelsAsync([/* ... */]);

Returns a list of the trained models in a collaboration.

Parameter Syntax

$result = $client->listCollaborationTrainedModels([
    'collaborationIdentifier' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'collaborationTrainedModels' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmAssociationArn' => '<string>',
            'createTime' => <DateTime>,
            'creatorAccountId' => '<string>',
            'description' => '<string>',
            'membershipIdentifier' => '<string>',
            'name' => '<string>',
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE|CANCEL_PENDING|CANCEL_IN_PROGRESS|CANCEL_FAILED',
            'trainedModelArn' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListConfiguredAudienceModels

$result = $client->listConfiguredAudienceModels([/* ... */]);
$promise = $client->listConfiguredAudienceModelsAsync([/* ... */]);

Returns a list of the configured audience models.

Parameter Syntax

$result = $client->listConfiguredAudienceModels([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModels' => [
        [
            'audienceModelArn' => '<string>',
            'configuredAudienceModelArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'outputConfig' => [
                'destination' => [
                    's3Destination' => [
                        's3Uri' => '<string>',
                    ],
                ],
                'roleArn' => '<string>',
            ],
            'status' => 'ACTIVE',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListConfiguredModelAlgorithmAssociations

$result = $client->listConfiguredModelAlgorithmAssociations([/* ... */]);
$promise = $client->listConfiguredModelAlgorithmAssociationsAsync([/* ... */]);

Returns a list of configured model algorithm associations.

Parameter Syntax

$result = $client->listConfiguredModelAlgorithmAssociations([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configuredModelAlgorithmAssociations' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmArn' => '<string>',
            'configuredModelAlgorithmAssociationArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'membershipIdentifier' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListConfiguredModelAlgorithms

$result = $client->listConfiguredModelAlgorithms([/* ... */]);
$promise = $client->listConfiguredModelAlgorithmsAsync([/* ... */]);

Returns a list of configured model algorithms.

Parameter Syntax

$result = $client->listConfiguredModelAlgorithms([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configuredModelAlgorithms' => [
        [
            'configuredModelAlgorithmArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListMLInputChannels

$result = $client->listMLInputChannels([/* ... */]);
$promise = $client->listMLInputChannelsAsync([/* ... */]);

Returns a list of ML input channels.

Parameter Syntax

$result = $client->listMLInputChannels([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'mlInputChannelsList' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmAssociations' => ['<string>', ...],
            'createTime' => <DateTime>,
            'description' => '<string>',
            'membershipIdentifier' => '<string>',
            'mlInputChannelArn' => '<string>',
            'name' => '<string>',
            'protectedQueryIdentifier' => '<string>',
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for a provided resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ListTrainedModelInferenceJobs

$result = $client->listTrainedModelInferenceJobs([/* ... */]);
$promise = $client->listTrainedModelInferenceJobsAsync([/* ... */]);

Returns a list of trained model inference jobs that match the request parameters.

Parameter Syntax

$result = $client->listTrainedModelInferenceJobs([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
    'trainedModelArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'trainedModelInferenceJobs' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmAssociationArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'logsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
            'logsStatusDetails' => '<string>',
            'membershipIdentifier' => '<string>',
            'metricsStatus' => 'PUBLISH_SUCCEEDED|PUBLISH_FAILED',
            'metricsStatusDetails' => '<string>',
            'name' => '<string>',
            'outputConfiguration' => [
                'accept' => '<string>',
                'members' => [
                    [
                        'accountId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|CANCEL_PENDING|CANCEL_IN_PROGRESS|CANCEL_FAILED|INACTIVE',
            'trainedModelArn' => '<string>',
            'trainedModelInferenceJobArn' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListTrainedModels

$result = $client->listTrainedModels([/* ... */]);
$promise = $client->listTrainedModelsAsync([/* ... */]);

Returns a list of trained models.

Parameter Syntax

$result = $client->listTrainedModels([
    'maxResults' => <integer>,
    'membershipIdentifier' => '<string>', // REQUIRED
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'trainedModels' => [
        [
            'collaborationIdentifier' => '<string>',
            'configuredModelAlgorithmAssociationArn' => '<string>',
            'createTime' => <DateTime>,
            'description' => '<string>',
            'membershipIdentifier' => '<string>',
            'name' => '<string>',
            'status' => 'CREATE_PENDING|CREATE_IN_PROGRESS|CREATE_FAILED|ACTIVE|DELETE_PENDING|DELETE_IN_PROGRESS|DELETE_FAILED|INACTIVE|CANCEL_PENDING|CANCEL_IN_PROGRESS|CANCEL_FAILED',
            'trainedModelArn' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListTrainingDatasets

$result = $client->listTrainingDatasets([/* ... */]);
$promise = $client->listTrainingDatasetsAsync([/* ... */]);

Returns a list of training datasets.

Parameter Syntax

$result = $client->listTrainingDatasets([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'trainingDatasets' => [
        [
            'createTime' => <DateTime>,
            'description' => '<string>',
            'name' => '<string>',
            'status' => 'ACTIVE',
            'trainingDatasetArn' => '<string>',
            'updateTime' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

PutConfiguredAudienceModelPolicy

$result = $client->putConfiguredAudienceModelPolicy([/* ... */]);
$promise = $client->putConfiguredAudienceModelPolicyAsync([/* ... */]);

Create or update the resource policy for a configured audience model.

Parameter Syntax

$result = $client->putConfiguredAudienceModelPolicy([
    'configuredAudienceModelArn' => '<string>', // REQUIRED
    'configuredAudienceModelPolicy' => '<string>', // REQUIRED
    'policyExistenceCondition' => 'POLICY_MUST_EXIST|POLICY_MUST_NOT_EXIST',
    'previousPolicyHash' => '<string>',
]);

Parameter Details

Result Syntax

[
    'configuredAudienceModelPolicy' => '<string>',
    'policyHash' => '<string>',
]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

PutMLConfiguration

$result = $client->putMLConfiguration([/* ... */]);
$promise = $client->putMLConfigurationAsync([/* ... */]);

Assigns information about an ML configuration.

Parameter Syntax

$result = $client->putMLConfiguration([
    'defaultOutputLocation' => [ // REQUIRED
        'destination' => [
            's3Destination' => [ // REQUIRED
                's3Uri' => '<string>', // REQUIRED
            ],
        ],
        'roleArn' => '<string>', // REQUIRED
    ],
    'membershipIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

StartAudienceExportJob

$result = $client->startAudienceExportJob([/* ... */]);
$promise = $client->startAudienceExportJobAsync([/* ... */]);

Export an audience of a specified size after you have generated an audience.

Parameter Syntax

$result = $client->startAudienceExportJob([
    'audienceGenerationJobArn' => '<string>', // REQUIRED
    'audienceSize' => [ // REQUIRED
        'type' => 'ABSOLUTE|PERCENTAGE', // REQUIRED
        'value' => <integer>, // REQUIRED
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ServiceQuotaExceededException:

You have exceeded your service quota.

StartAudienceGenerationJob

$result = $client->startAudienceGenerationJob([/* ... */]);
$promise = $client->startAudienceGenerationJobAsync([/* ... */]);

Information necessary to start the audience generation job.

Parameter Syntax

$result = $client->startAudienceGenerationJob([
    'collaborationId' => '<string>',
    'configuredAudienceModelArn' => '<string>', // REQUIRED
    'description' => '<string>',
    'includeSeedInOutput' => true || false,
    'name' => '<string>', // REQUIRED
    'seedAudience' => [ // REQUIRED
        'dataSource' => [
            's3Uri' => '<string>', // REQUIRED
        ],
        'roleArn' => '<string>', // REQUIRED
        'sqlParameters' => [
            'analysisTemplateArn' => '<string>',
            'parameters' => ['<string>', ...],
            'queryString' => '<string>',
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'audienceGenerationJobArn' => '<string>',
]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

ServiceQuotaExceededException:

You have exceeded your service quota.

StartTrainedModelExportJob

$result = $client->startTrainedModelExportJob([/* ... */]);
$promise = $client->startTrainedModelExportJobAsync([/* ... */]);

Provides the information necessary to start a trained model export job.

Parameter Syntax

$result = $client->startTrainedModelExportJob([
    'description' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'outputConfiguration' => [ // REQUIRED
        'members' => [ // REQUIRED
            [
                'accountId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'trainedModelArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

You can't complete this action because another resource depends on this resource.

ValidationException:

The request parameters for this request are incorrect.

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The resource you are requesting does not exist.

StartTrainedModelInferenceJob

$result = $client->startTrainedModelInferenceJob([/* ... */]);
$promise = $client->startTrainedModelInferenceJobAsync([/* ... */]);

Defines the information necessary to begin a trained model inference job.

Parameter Syntax

$result = $client->startTrainedModelInferenceJob([
    'configuredModelAlgorithmAssociationArn' => '<string>',
    'containerExecutionParameters' => [
        'maxPayloadInMB' => <integer>,
    ],
    'dataSource' => [ // REQUIRED
        'mlInputChannelArn' => '<string>', // REQUIRED
    ],
    'description' => '<string>',
    'environment' => ['<string>', ...],
    'kmsKeyArn' => '<string>',
    'membershipIdentifier' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
    'outputConfiguration' => [ // REQUIRED
        'accept' => '<string>',
        'members' => [ // REQUIRED
            [
                'accountId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'resourceConfig' => [ // REQUIRED
        'instanceCount' => <integer>,
        'instanceType' => 'ml.r7i.48xlarge|ml.r6i.16xlarge|ml.m6i.xlarge|ml.m5.4xlarge|ml.p2.xlarge|ml.m4.16xlarge|ml.r7i.16xlarge|ml.m7i.xlarge|ml.m6i.12xlarge|ml.r7i.8xlarge|ml.r7i.large|ml.m7i.12xlarge|ml.m6i.24xlarge|ml.m7i.24xlarge|ml.r6i.8xlarge|ml.r6i.large|ml.g5.2xlarge|ml.m5.large|ml.p3.16xlarge|ml.m7i.48xlarge|ml.m6i.16xlarge|ml.p2.16xlarge|ml.g5.4xlarge|ml.m7i.16xlarge|ml.c4.2xlarge|ml.c5.2xlarge|ml.c6i.32xlarge|ml.c4.4xlarge|ml.g5.8xlarge|ml.c6i.xlarge|ml.c5.4xlarge|ml.g4dn.xlarge|ml.c7i.xlarge|ml.c6i.12xlarge|ml.g4dn.12xlarge|ml.c7i.12xlarge|ml.c6i.24xlarge|ml.g4dn.2xlarge|ml.c7i.24xlarge|ml.c7i.2xlarge|ml.c4.8xlarge|ml.c6i.2xlarge|ml.g4dn.4xlarge|ml.c7i.48xlarge|ml.c7i.4xlarge|ml.c6i.16xlarge|ml.c5.9xlarge|ml.g4dn.16xlarge|ml.c7i.16xlarge|ml.c6i.4xlarge|ml.c5.xlarge|ml.c4.xlarge|ml.g4dn.8xlarge|ml.c7i.8xlarge|ml.c7i.large|ml.g5.xlarge|ml.c6i.8xlarge|ml.c6i.large|ml.g5.12xlarge|ml.g5.24xlarge|ml.m7i.2xlarge|ml.c5.18xlarge|ml.g5.48xlarge|ml.m6i.2xlarge|ml.g5.16xlarge|ml.m7i.4xlarge|ml.p3.2xlarge|ml.r6i.32xlarge|ml.m6i.4xlarge|ml.m5.xlarge|ml.m4.10xlarge|ml.r6i.xlarge|ml.m5.12xlarge|ml.m4.xlarge|ml.r7i.2xlarge|ml.r7i.xlarge|ml.r6i.12xlarge|ml.m5.24xlarge|ml.r7i.12xlarge|ml.m7i.8xlarge|ml.m7i.large|ml.r6i.24xlarge|ml.r6i.2xlarge|ml.m4.2xlarge|ml.r7i.24xlarge|ml.r7i.4xlarge|ml.m6i.8xlarge|ml.m6i.large|ml.m5.2xlarge|ml.p2.8xlarge|ml.r6i.4xlarge|ml.m6i.32xlarge|ml.p3.8xlarge|ml.m4.4xlarge', // REQUIRED
    ],
    'tags' => ['<string>', ...],
    'trainedModelArn' => '<string>', // REQUIRED
]);

Parameter Details