CreateDataset

$result = $client->createDataset([/* ... */]);
$promise = $client->createDatasetAsync([/* ... */]);

Creates a container for a collection of data being ingested for analysis. The dataset contains the metadata describing where the data is and what the data actually looks like. For example, it contains the location of the data source, the data schema, and other information. A dataset also contains any tags associated with the ingested data.

Parameter Syntax

$result = $client->createDataset([
    'ClientToken' => '<string>', // REQUIRED
    'DatasetName' => '<string>', // REQUIRED
    'DatasetSchema' => [
        'InlineDataSchema' => '<string>',
    ],
    'ServerSideKmsKeyId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DatasetArn' => '<string>',
    'DatasetName' => '<string>',
    'Status' => 'CREATED|INGESTION_IN_PROGRESS|ACTIVE|IMPORT_IN_PROGRESS',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

CreateInferenceScheduler

$result = $client->createInferenceScheduler([/* ... */]);
$promise = $client->createInferenceSchedulerAsync([/* ... */]);

Creates a scheduled inference. Scheduling an inference is setting up a continuous real-time inference plan to analyze new measurement data. When setting up the schedule, you provide an S3 bucket location for the input data, assign it a delimiter between separate entries in the data, set an offset delay if desired, and set the frequency of inferencing. You must also provide an S3 bucket location for the output data.

Parameter Syntax

$result = $client->createInferenceScheduler([
    'ClientToken' => '<string>', // REQUIRED
    'DataDelayOffsetInMinutes' => <integer>,
    'DataInputConfiguration' => [ // REQUIRED
        'InferenceInputNameConfiguration' => [
            'ComponentTimestampDelimiter' => '<string>',
            'TimestampFormat' => '<string>',
        ],
        'InputTimeZoneOffset' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'DataOutputConfiguration' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3OutputConfiguration' => [ // REQUIRED
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'DataUploadFrequency' => 'PT5M|PT10M|PT15M|PT30M|PT1H', // REQUIRED
    'InferenceSchedulerName' => '<string>', // REQUIRED
    'ModelName' => '<string>', // REQUIRED
    'RoleArn' => '<string>', // REQUIRED
    'ServerSideKmsKeyId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'InferenceSchedulerArn' => '<string>',
    'InferenceSchedulerName' => '<string>',
    'ModelQuality' => 'QUALITY_THRESHOLD_MET|CANNOT_DETERMINE_QUALITY|POOR_QUALITY_DETECTED',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]

Result Details

Errors

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

CreateLabel

$result = $client->createLabel([/* ... */]);
$promise = $client->createLabelAsync([/* ... */]);

Creates a label for an event.

Parameter Syntax

$result = $client->createLabel([
    'ClientToken' => '<string>', // REQUIRED
    'EndTime' => <integer || string || DateTime>, // REQUIRED
    'Equipment' => '<string>',
    'FaultCode' => '<string>',
    'LabelGroupName' => '<string>', // REQUIRED
    'Notes' => '<string>',
    'Rating' => 'ANOMALY|NO_ANOMALY|NEUTRAL', // REQUIRED
    'StartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

CreateLabelGroup

$result = $client->createLabelGroup([/* ... */]);
$promise = $client->createLabelGroupAsync([/* ... */]);

Creates a group of labels.

Parameter Syntax

$result = $client->createLabelGroup([
    'ClientToken' => '<string>', // REQUIRED
    'FaultCodes' => ['<string>', ...],
    'LabelGroupName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'LabelGroupArn' => '<string>',
    'LabelGroupName' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

CreateModel

$result = $client->createModel([/* ... */]);
$promise = $client->createModelAsync([/* ... */]);

Creates a machine learning model for data inference.

A machine-learning (ML) model is a mathematical model that finds patterns in your data. In Amazon Lookout for Equipment, the model learns the patterns of normal behavior and detects abnormal behavior that could be potential equipment failure (or maintenance events). The models are made by analyzing normal data and abnormalities in machine behavior that have already occurred.

Your model is trained using a portion of the data from your dataset and uses that data to learn patterns of normal behavior and abnormal patterns that lead to equipment failure. Another portion of the data is used to evaluate the model's accuracy.

Parameter Syntax

$result = $client->createModel([
    'ClientToken' => '<string>', // REQUIRED
    'DataPreProcessingConfiguration' => [
        'TargetSamplingRate' => 'PT1S|PT5S|PT10S|PT15S|PT30S|PT1M|PT5M|PT10M|PT15M|PT30M|PT1H',
    ],
    'DatasetName' => '<string>', // REQUIRED
    'DatasetSchema' => [
        'InlineDataSchema' => '<string>',
    ],
    'EvaluationDataEndTime' => <integer || string || DateTime>,
    'EvaluationDataStartTime' => <integer || string || DateTime>,
    'LabelsInputConfiguration' => [
        'LabelGroupName' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'ModelDiagnosticsOutputConfiguration' => [
        'KmsKeyId' => '<string>',
        'S3OutputConfiguration' => [ // REQUIRED
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'ModelName' => '<string>', // REQUIRED
    'OffCondition' => '<string>',
    'RoleArn' => '<string>',
    'ServerSideKmsKeyId' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TrainingDataEndTime' => <integer || string || DateTime>,
    'TrainingDataStartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'ModelArn' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

CreateRetrainingScheduler

$result = $client->createRetrainingScheduler([/* ... */]);
$promise = $client->createRetrainingSchedulerAsync([/* ... */]);

Creates a retraining scheduler on the specified model.

Parameter Syntax

$result = $client->createRetrainingScheduler([
    'ClientToken' => '<string>', // REQUIRED
    'LookbackWindow' => '<string>', // REQUIRED
    'ModelName' => '<string>', // REQUIRED
    'PromoteMode' => 'MANAGED|MANUAL',
    'RetrainingFrequency' => '<string>', // REQUIRED
    'RetrainingStartDate' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Creates a retraining scheduler with manual promote mode

$result = $client->createRetrainingScheduler([
    'ClientToken' => 'sample-client-token',
    'LookbackWindow' => 'P360D',
    'ModelName' => 'sample-model',
    'PromoteMode' => 'MANUAL',
    'RetrainingFrequency' => 'P1M',
]);

Result syntax:

[
    'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'ModelName' => 'sample-model',
    'Status' => 'PENDING',
]

Example 2: Creates a retraining scheduler with a specific start date

$result = $client->createRetrainingScheduler([
    'ClientToken' => 'sample-client-token',
    'LookbackWindow' => 'P360D',
    'ModelName' => 'sample-model',
    'RetrainingFrequency' => 'P1M',
    'RetrainingStartDate' => ,
]);

Result syntax:

[
    'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'ModelName' => 'sample-model',
    'Status' => 'PENDING',
]

DeleteDataset

$result = $client->deleteDataset([/* ... */]);
$promise = $client->deleteDatasetAsync([/* ... */]);

Deletes a dataset and associated artifacts. The operation will check to see if any inference scheduler or data ingestion job is currently using the dataset, and if there isn't, the dataset, its metadata, and any associated data stored in S3 will be deleted. This does not affect any models that used this dataset for training and evaluation, but does prevent it from being used in the future.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

DeleteInferenceScheduler

$result = $client->deleteInferenceScheduler([/* ... */]);
$promise = $client->deleteInferenceSchedulerAsync([/* ... */]);

Deletes an inference scheduler that has been set up. Prior inference results will not be deleted.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DeleteLabel

$result = $client->deleteLabel([/* ... */]);
$promise = $client->deleteLabelAsync([/* ... */]);

Deletes a label.

Parameter Syntax

$result = $client->deleteLabel([
    'LabelGroupName' => '<string>', // REQUIRED
    'LabelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

DeleteLabelGroup

$result = $client->deleteLabelGroup([/* ... */]);
$promise = $client->deleteLabelGroupAsync([/* ... */]);

Deletes a group of labels.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

DeleteModel

$result = $client->deleteModel([/* ... */]);
$promise = $client->deleteModelAsync([/* ... */]);

Deletes a machine learning model currently available for Amazon Lookout for Equipment. This will prevent it from being used with an inference scheduler, even one that is already set up.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource policy attached to the resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

DeleteRetrainingScheduler

$result = $client->deleteRetrainingScheduler([/* ... */]);
$promise = $client->deleteRetrainingSchedulerAsync([/* ... */]);

Deletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Deletes a retraining scheduler

$result = $client->deleteRetrainingScheduler([
    'ModelName' => 'sample-model',
]);

DescribeDataIngestionJob

$result = $client->describeDataIngestionJob([/* ... */]);
$promise = $client->describeDataIngestionJobAsync([/* ... */]);

Provides information on a specific data ingestion job such as creation time, dataset ARN, and status.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DataEndTime' => <DateTime>,
    'DataQualitySummary' => [
        'DuplicateTimestamps' => [
            'TotalNumberOfDuplicateTimestamps' => <integer>,
        ],
        'InsufficientSensorData' => [
            'MissingCompleteSensorData' => [
                'AffectedSensorCount' => <integer>,
            ],
            'SensorsWithShortDateRange' => [
                'AffectedSensorCount' => <integer>,
            ],
        ],
        'InvalidSensorData' => [
            'AffectedSensorCount' => <integer>,
            'TotalNumberOfInvalidValues' => <integer>,
        ],
        'MissingSensorData' => [
            'AffectedSensorCount' => <integer>,
            'TotalNumberOfMissingValues' => <integer>,
        ],
        'UnsupportedTimestamps' => [
            'TotalNumberOfUnsupportedTimestamps' => <integer>,
        ],
    ],
    'DataStartTime' => <DateTime>,
    'DatasetArn' => '<string>',
    'FailedReason' => '<string>',
    'IngestedDataSize' => <integer>,
    'IngestedFilesSummary' => [
        'DiscardedFiles' => [
            [
                'Bucket' => '<string>',
                'Key' => '<string>',
            ],
            // ...
        ],
        'IngestedNumberOfFiles' => <integer>,
        'TotalNumberOfFiles' => <integer>,
    ],
    'IngestionInputConfiguration' => [
        'S3InputConfiguration' => [
            'Bucket' => '<string>',
            'KeyPattern' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'JobId' => '<string>',
    'RoleArn' => '<string>',
    'SourceDatasetArn' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
    'StatusDetail' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeDataset

$result = $client->describeDataset([/* ... */]);
$promise = $client->describeDatasetAsync([/* ... */]);

Provides a JSON description of the data in each time series dataset, including names, column names, and data types.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DataEndTime' => <DateTime>,
    'DataQualitySummary' => [
        'DuplicateTimestamps' => [
            'TotalNumberOfDuplicateTimestamps' => <integer>,
        ],
        'InsufficientSensorData' => [
            'MissingCompleteSensorData' => [
                'AffectedSensorCount' => <integer>,
            ],
            'SensorsWithShortDateRange' => [
                'AffectedSensorCount' => <integer>,
            ],
        ],
        'InvalidSensorData' => [
            'AffectedSensorCount' => <integer>,
            'TotalNumberOfInvalidValues' => <integer>,
        ],
        'MissingSensorData' => [
            'AffectedSensorCount' => <integer>,
            'TotalNumberOfMissingValues' => <integer>,
        ],
        'UnsupportedTimestamps' => [
            'TotalNumberOfUnsupportedTimestamps' => <integer>,
        ],
    ],
    'DataStartTime' => <DateTime>,
    'DatasetArn' => '<string>',
    'DatasetName' => '<string>',
    'IngestedFilesSummary' => [
        'DiscardedFiles' => [
            [
                'Bucket' => '<string>',
                'Key' => '<string>',
            ],
            // ...
        ],
        'IngestedNumberOfFiles' => <integer>,
        'TotalNumberOfFiles' => <integer>,
    ],
    'IngestionInputConfiguration' => [
        'S3InputConfiguration' => [
            'Bucket' => '<string>',
            'KeyPattern' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'LastUpdatedAt' => <DateTime>,
    'RoleArn' => '<string>',
    'Schema' => '<string>',
    'ServerSideKmsKeyId' => '<string>',
    'SourceDatasetArn' => '<string>',
    'Status' => 'CREATED|INGESTION_IN_PROGRESS|ACTIVE|IMPORT_IN_PROGRESS',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeInferenceScheduler

$result = $client->describeInferenceScheduler([/* ... */]);
$promise = $client->describeInferenceSchedulerAsync([/* ... */]);

Specifies information about the inference scheduler being used, including name, model, status, and associated metadata

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'DataDelayOffsetInMinutes' => <integer>,
    'DataInputConfiguration' => [
        'InferenceInputNameConfiguration' => [
            'ComponentTimestampDelimiter' => '<string>',
            'TimestampFormat' => '<string>',
        ],
        'InputTimeZoneOffset' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'DataOutputConfiguration' => [
        'KmsKeyId' => '<string>',
        'S3OutputConfiguration' => [
            'Bucket' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'DataUploadFrequency' => 'PT5M|PT10M|PT15M|PT30M|PT1H',
    'InferenceSchedulerArn' => '<string>',
    'InferenceSchedulerName' => '<string>',
    'LatestInferenceResult' => 'ANOMALOUS|NORMAL',
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'RoleArn' => '<string>',
    'ServerSideKmsKeyId' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeLabel

$result = $client->describeLabel([/* ... */]);
$promise = $client->describeLabelAsync([/* ... */]);

Returns the name of the label.

Parameter Syntax

$result = $client->describeLabel([
    'LabelGroupName' => '<string>', // REQUIRED
    'LabelId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'EndTime' => <DateTime>,
    'Equipment' => '<string>',
    'FaultCode' => '<string>',
    'LabelGroupArn' => '<string>',
    'LabelGroupName' => '<string>',
    'LabelId' => '<string>',
    'Notes' => '<string>',
    'Rating' => 'ANOMALY|NO_ANOMALY|NEUTRAL',
    'StartTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeLabelGroup

$result = $client->describeLabelGroup([/* ... */]);
$promise = $client->describeLabelGroupAsync([/* ... */]);

Returns information about the label group.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'FaultCodes' => ['<string>', ...],
    'LabelGroupArn' => '<string>',
    'LabelGroupName' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeModel

$result = $client->describeModel([/* ... */]);
$promise = $client->describeModelAsync([/* ... */]);

Provides a JSON containing the overall information about a specific machine learning model, including model name and ARN, dataset, training and evaluation information, status, and so on.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AccumulatedInferenceDataEndTime' => <DateTime>,
    'AccumulatedInferenceDataStartTime' => <DateTime>,
    'ActiveModelVersion' => <integer>,
    'ActiveModelVersionArn' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataPreProcessingConfiguration' => [
        'TargetSamplingRate' => 'PT1S|PT5S|PT10S|PT15S|PT30S|PT1M|PT5M|PT10M|PT15M|PT30M|PT1H',
    ],
    'DatasetArn' => '<string>',
    'DatasetName' => '<string>',
    'EvaluationDataEndTime' => <DateTime>,
    'EvaluationDataStartTime' => <DateTime>,
    'FailedReason' => '<string>',
    'ImportJobEndTime' => <DateTime>,
    'ImportJobStartTime' => <DateTime>,
    'LabelsInputConfiguration' => [
        'LabelGroupName' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'LastUpdatedTime' => <DateTime>,
    'LatestScheduledRetrainingAvailableDataInDays' => <integer>,
    'LatestScheduledRetrainingFailedReason' => '<string>',
    'LatestScheduledRetrainingModelVersion' => <integer>,
    'LatestScheduledRetrainingStartTime' => <DateTime>,
    'LatestScheduledRetrainingStatus' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS|CANCELED',
    'ModelArn' => '<string>',
    'ModelDiagnosticsOutputConfiguration' => [
        'KmsKeyId' => '<string>',
        'S3OutputConfiguration' => [
            'Bucket' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'ModelMetrics' => '<string>',
    'ModelName' => '<string>',
    'ModelQuality' => 'QUALITY_THRESHOLD_MET|CANNOT_DETERMINE_QUALITY|POOR_QUALITY_DETECTED',
    'ModelVersionActivatedAt' => <DateTime>,
    'NextScheduledRetrainingStartDate' => <DateTime>,
    'OffCondition' => '<string>',
    'PreviousActiveModelVersion' => <integer>,
    'PreviousActiveModelVersionArn' => '<string>',
    'PreviousModelVersionActivatedAt' => <DateTime>,
    'PriorModelMetrics' => '<string>',
    'RetrainingSchedulerStatus' => 'PENDING|RUNNING|STOPPING|STOPPED',
    'RoleArn' => '<string>',
    'Schema' => '<string>',
    'ServerSideKmsKeyId' => '<string>',
    'SourceModelVersionArn' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
    'TrainingDataEndTime' => <DateTime>,
    'TrainingDataStartTime' => <DateTime>,
    'TrainingExecutionEndTime' => <DateTime>,
    'TrainingExecutionStartTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeModelVersion

$result = $client->describeModelVersion([/* ... */]);
$promise = $client->describeModelVersionAsync([/* ... */]);

Retrieves information about a specific machine learning model version.

Parameter Syntax

$result = $client->describeModelVersion([
    'ModelName' => '<string>', // REQUIRED
    'ModelVersion' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AutoPromotionResult' => 'MODEL_PROMOTED|MODEL_NOT_PROMOTED|RETRAINING_INTERNAL_ERROR|RETRAINING_CUSTOMER_ERROR|RETRAINING_CANCELLED',
    'AutoPromotionResultReason' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataPreProcessingConfiguration' => [
        'TargetSamplingRate' => 'PT1S|PT5S|PT10S|PT15S|PT30S|PT1M|PT5M|PT10M|PT15M|PT30M|PT1H',
    ],
    'DatasetArn' => '<string>',
    'DatasetName' => '<string>',
    'EvaluationDataEndTime' => <DateTime>,
    'EvaluationDataStartTime' => <DateTime>,
    'FailedReason' => '<string>',
    'ImportJobEndTime' => <DateTime>,
    'ImportJobStartTime' => <DateTime>,
    'ImportedDataSizeInBytes' => <integer>,
    'LabelsInputConfiguration' => [
        'LabelGroupName' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'LastUpdatedTime' => <DateTime>,
    'ModelArn' => '<string>',
    'ModelDiagnosticsOutputConfiguration' => [
        'KmsKeyId' => '<string>',
        'S3OutputConfiguration' => [
            'Bucket' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'ModelDiagnosticsResultsObject' => [
        'Bucket' => '<string>',
        'Key' => '<string>',
    ],
    'ModelMetrics' => '<string>',
    'ModelName' => '<string>',
    'ModelQuality' => 'QUALITY_THRESHOLD_MET|CANNOT_DETERMINE_QUALITY|POOR_QUALITY_DETECTED',
    'ModelVersion' => <integer>,
    'ModelVersionArn' => '<string>',
    'OffCondition' => '<string>',
    'PriorModelMetrics' => '<string>',
    'RetrainingAvailableDataInDays' => <integer>,
    'RoleArn' => '<string>',
    'Schema' => '<string>',
    'ServerSideKmsKeyId' => '<string>',
    'SourceModelVersionArn' => '<string>',
    'SourceType' => 'TRAINING|RETRAINING|IMPORT',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS|CANCELED',
    'TrainingDataEndTime' => <DateTime>,
    'TrainingDataStartTime' => <DateTime>,
    'TrainingExecutionEndTime' => <DateTime>,
    'TrainingExecutionStartTime' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeResourcePolicy

$result = $client->describeResourcePolicy([/* ... */]);
$promise = $client->describeResourcePolicyAsync([/* ... */]);

Provides the details of a resource policy attached to a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LastModifiedTime' => <DateTime>,
    'PolicyRevisionId' => '<string>',
    'ResourcePolicy' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

DescribeRetrainingScheduler

$result = $client->describeRetrainingScheduler([/* ... */]);
$promise = $client->describeRetrainingSchedulerAsync([/* ... */]);

Provides a description of the retraining scheduler, including information such as the model name and retraining parameters.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => <DateTime>,
    'LookbackWindow' => '<string>',
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'PromoteMode' => 'MANAGED|MANUAL',
    'RetrainingFrequency' => '<string>',
    'RetrainingStartDate' => <DateTime>,
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Describes a retraining scheduler

$result = $client->describeRetrainingScheduler([
    'ModelName' => 'sample-model',
]);

Result syntax:

[
    'CreatedAt' => ,
    'LookbackWindow' => 'P360D',
    'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'ModelName' => 'sample-model',
    'PromoteMode' => 'MANAGED',
    'RetrainingFrequency' => 'P1M',
    'RetrainingStartDate' => ,
    'Status' => 'RUNNING',
    'UpdatedAt' => ,
]

ImportDataset

$result = $client->importDataset([/* ... */]);
$promise = $client->importDatasetAsync([/* ... */]);

Imports a dataset.

Parameter Syntax

$result = $client->importDataset([
    'ClientToken' => '<string>', // REQUIRED
    'DatasetName' => '<string>',
    'ServerSideKmsKeyId' => '<string>',
    'SourceDatasetArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'DatasetArn' => '<string>',
    'DatasetName' => '<string>',
    'JobId' => '<string>',
    'Status' => 'CREATED|INGESTION_IN_PROGRESS|ACTIVE|IMPORT_IN_PROGRESS',
]

Result Details

Errors

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ImportModelVersion

$result = $client->importModelVersion([/* ... */]);
$promise = $client->importModelVersionAsync([/* ... */]);

Imports a model that has been trained successfully.

Parameter Syntax

$result = $client->importModelVersion([
    'ClientToken' => '<string>', // REQUIRED
    'DatasetName' => '<string>', // REQUIRED
    'InferenceDataImportStrategy' => 'NO_IMPORT|ADD_WHEN_EMPTY|OVERWRITE',
    'LabelsInputConfiguration' => [
        'LabelGroupName' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'ModelName' => '<string>',
    'RoleArn' => '<string>',
    'ServerSideKmsKeyId' => '<string>',
    'SourceModelVersionArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'ModelVersion' => <integer>,
    'ModelVersionArn' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS|CANCELED',
]

Result Details

Errors

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListDataIngestionJobs

$result = $client->listDataIngestionJobs([/* ... */]);
$promise = $client->listDataIngestionJobsAsync([/* ... */]);

Provides a list of all data ingestion jobs, including dataset name and ARN, S3 location of the input data, status, and so on.

Parameter Syntax

$result = $client->listDataIngestionJobs([
    'DatasetName' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
]);

Parameter Details

Result Syntax

[
    'DataIngestionJobSummaries' => [
        [
            'DatasetArn' => '<string>',
            'DatasetName' => '<string>',
            'IngestionInputConfiguration' => [
                'S3InputConfiguration' => [
                    'Bucket' => '<string>',
                    'KeyPattern' => '<string>',
                    'Prefix' => '<string>',
                ],
            ],
            'JobId' => '<string>',
            'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListDatasets

$result = $client->listDatasets([/* ... */]);
$promise = $client->listDatasetsAsync([/* ... */]);

Lists all datasets currently available in your account, filtering on the dataset name.

Parameter Syntax

$result = $client->listDatasets([
    'DatasetNameBeginsWith' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DatasetSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'DatasetArn' => '<string>',
            'DatasetName' => '<string>',
            'Status' => 'CREATED|INGESTION_IN_PROGRESS|ACTIVE|IMPORT_IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListInferenceEvents

$result = $client->listInferenceEvents([/* ... */]);
$promise = $client->listInferenceEventsAsync([/* ... */]);

Lists all inference events that have been found for the specified inference scheduler.

Parameter Syntax

$result = $client->listInferenceEvents([
    'InferenceSchedulerName' => '<string>', // REQUIRED
    'IntervalEndTime' => <integer || string || DateTime>, // REQUIRED
    'IntervalStartTime' => <integer || string || DateTime>, // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'InferenceEventSummaries' => [
        [
            'Diagnostics' => '<string>',
            'EventDurationInSeconds' => <integer>,
            'EventEndTime' => <DateTime>,
            'EventStartTime' => <DateTime>,
            'InferenceSchedulerArn' => '<string>',
            'InferenceSchedulerName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListInferenceExecutions

$result = $client->listInferenceExecutions([/* ... */]);
$promise = $client->listInferenceExecutionsAsync([/* ... */]);

Lists all inference executions that have been performed by the specified inference scheduler.

Parameter Syntax

$result = $client->listInferenceExecutions([
    'DataEndTimeBefore' => <integer || string || DateTime>,
    'DataStartTimeAfter' => <integer || string || DateTime>,
    'InferenceSchedulerName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED',
]);

Parameter Details

Result Syntax

[
    'InferenceExecutionSummaries' => [
        [
            'CustomerResultObject' => [
                'Bucket' => '<string>',
                'Key' => '<string>',
            ],
            'DataEndTime' => <DateTime>,
            'DataInputConfiguration' => [
                'InferenceInputNameConfiguration' => [
                    'ComponentTimestampDelimiter' => '<string>',
                    'TimestampFormat' => '<string>',
                ],
                'InputTimeZoneOffset' => '<string>',
                'S3InputConfiguration' => [
                    'Bucket' => '<string>',
                    'Prefix' => '<string>',
                ],
            ],
            'DataOutputConfiguration' => [
                'KmsKeyId' => '<string>',
                'S3OutputConfiguration' => [
                    'Bucket' => '<string>',
                    'Prefix' => '<string>',
                ],
            ],
            'DataStartTime' => <DateTime>,
            'FailedReason' => '<string>',
            'InferenceSchedulerArn' => '<string>',
            'InferenceSchedulerName' => '<string>',
            'ModelArn' => '<string>',
            'ModelName' => '<string>',
            'ModelVersion' => <integer>,
            'ModelVersionArn' => '<string>',
            'ScheduledStartTime' => <DateTime>,
            'Status' => 'IN_PROGRESS|SUCCESS|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListInferenceSchedulers

$result = $client->listInferenceSchedulers([/* ... */]);
$promise = $client->listInferenceSchedulersAsync([/* ... */]);

Retrieves a list of all inference schedulers currently available for your account.

Parameter Syntax

$result = $client->listInferenceSchedulers([
    'InferenceSchedulerNameBeginsWith' => '<string>',
    'MaxResults' => <integer>,
    'ModelName' => '<string>',
    'NextToken' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]);

Parameter Details

Result Syntax

[
    'InferenceSchedulerSummaries' => [
        [
            'DataDelayOffsetInMinutes' => <integer>,
            'DataUploadFrequency' => 'PT5M|PT10M|PT15M|PT30M|PT1H',
            'InferenceSchedulerArn' => '<string>',
            'InferenceSchedulerName' => '<string>',
            'LatestInferenceResult' => 'ANOMALOUS|NORMAL',
            'ModelArn' => '<string>',
            'ModelName' => '<string>',
            'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListLabelGroups

$result = $client->listLabelGroups([/* ... */]);
$promise = $client->listLabelGroupsAsync([/* ... */]);

Returns a list of the label groups.

Parameter Syntax

$result = $client->listLabelGroups([
    'LabelGroupNameBeginsWith' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LabelGroupSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'LabelGroupArn' => '<string>',
            'LabelGroupName' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListLabels

$result = $client->listLabels([/* ... */]);
$promise = $client->listLabelsAsync([/* ... */]);

Provides a list of labels.

Parameter Syntax

$result = $client->listLabels([
    'Equipment' => '<string>',
    'FaultCode' => '<string>',
    'IntervalEndTime' => <integer || string || DateTime>,
    'IntervalStartTime' => <integer || string || DateTime>,
    'LabelGroupName' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LabelSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'EndTime' => <DateTime>,
            'Equipment' => '<string>',
            'FaultCode' => '<string>',
            'LabelGroupArn' => '<string>',
            'LabelGroupName' => '<string>',
            'LabelId' => '<string>',
            'Rating' => 'ANOMALY|NO_ANOMALY|NEUTRAL',
            'StartTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListModelVersions

$result = $client->listModelVersions([/* ... */]);
$promise = $client->listModelVersionsAsync([/* ... */]);

Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.

Parameter Syntax

$result = $client->listModelVersions([
    'CreatedAtEndTime' => <integer || string || DateTime>,
    'CreatedAtStartTime' => <integer || string || DateTime>,
    'MaxModelVersion' => <integer>,
    'MaxResults' => <integer>,
    'MinModelVersion' => <integer>,
    'ModelName' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'SourceType' => 'TRAINING|RETRAINING|IMPORT',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS|CANCELED',
]);

Parameter Details

Result Syntax

[
    'ModelVersionSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'ModelArn' => '<string>',
            'ModelName' => '<string>',
            'ModelQuality' => 'QUALITY_THRESHOLD_MET|CANNOT_DETERMINE_QUALITY|POOR_QUALITY_DETECTED',
            'ModelVersion' => <integer>,
            'ModelVersionArn' => '<string>',
            'SourceType' => 'TRAINING|RETRAINING|IMPORT',
            'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS|CANCELED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListModels

$result = $client->listModels([/* ... */]);
$promise = $client->listModelsAsync([/* ... */]);

Generates a list of all models in the account, including model name and ARN, dataset, and status.

Parameter Syntax

$result = $client->listModels([
    'DatasetNameBeginsWith' => '<string>',
    'MaxResults' => <integer>,
    'ModelNameBeginsWith' => '<string>',
    'NextToken' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
]);

Parameter Details

Result Syntax

[
    'ModelSummaries' => [
        [
            'ActiveModelVersion' => <integer>,
            'ActiveModelVersionArn' => '<string>',
            'CreatedAt' => <DateTime>,
            'DatasetArn' => '<string>',
            'DatasetName' => '<string>',
            'LatestScheduledRetrainingModelVersion' => <integer>,
            'LatestScheduledRetrainingStartTime' => <DateTime>,
            'LatestScheduledRetrainingStatus' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS|CANCELED',
            'ModelArn' => '<string>',
            'ModelDiagnosticsOutputConfiguration' => [
                'KmsKeyId' => '<string>',
                'S3OutputConfiguration' => [
                    'Bucket' => '<string>',
                    'Prefix' => '<string>',
                ],
            ],
            'ModelName' => '<string>',
            'ModelQuality' => 'QUALITY_THRESHOLD_MET|CANNOT_DETERMINE_QUALITY|POOR_QUALITY_DETECTED',
            'NextScheduledRetrainingStartDate' => <DateTime>,
            'RetrainingSchedulerStatus' => 'PENDING|RUNNING|STOPPING|STOPPED',
            'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListRetrainingSchedulers

$result = $client->listRetrainingSchedulers([/* ... */]);
$promise = $client->listRetrainingSchedulersAsync([/* ... */]);

Lists all retraining schedulers in your account, filtering by model name prefix and status.

Parameter Syntax

$result = $client->listRetrainingSchedulers([
    'MaxResults' => <integer>,
    'ModelNameBeginsWith' => '<string>',
    'NextToken' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'RetrainingSchedulerSummaries' => [
        [
            'LookbackWindow' => '<string>',
            'ModelArn' => '<string>',
            'ModelName' => '<string>',
            'RetrainingFrequency' => '<string>',
            'RetrainingStartDate' => <DateTime>,
            'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Listing retraining schedulers

$result = $client->listRetrainingSchedulers([
    'MaxResults' => 50,
]);

Result syntax:

[
    'RetrainingSchedulerSummaries' => [
        [
            'LookbackWindow' => 'P180D',
            'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-1/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
            'ModelName' => 'sample-model-1',
            'RetrainingFrequency' => 'P1M',
            'RetrainingStartDate' => ,
            'Status' => 'RUNNING',
        ],
        [
            'LookbackWindow' => 'P180D',
            'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-2/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222',
            'ModelName' => 'sample-model-2',
            'RetrainingFrequency' => 'P30D',
            'RetrainingStartDate' => ,
            'Status' => 'RUNNING',
        ],
        [
            'LookbackWindow' => 'P360D',
            'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model-3/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333',
            'ModelName' => 'sample-model-3',
            'RetrainingFrequency' => 'P1M',
            'RetrainingStartDate' => ,
            'Status' => 'STOPPED',
        ],
    ],
]

ListSensorStatistics

$result = $client->listSensorStatistics([/* ... */]);
$promise = $client->listSensorStatisticsAsync([/* ... */]);

Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.

Parameter Syntax

$result = $client->listSensorStatistics([
    'DatasetName' => '<string>', // REQUIRED
    'IngestionJobId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'SensorStatisticsSummaries' => [
        [
            'CategoricalValues' => [
                'NumberOfCategory' => <integer>,
                'Status' => 'POTENTIAL_ISSUE_DETECTED|NO_ISSUE_DETECTED',
            ],
            'ComponentName' => '<string>',
            'DataEndTime' => <DateTime>,
            'DataExists' => true || false,
            'DataStartTime' => <DateTime>,
            'DuplicateTimestamps' => [
                'Count' => <integer>,
                'Percentage' => <float>,
            ],
            'InvalidDateEntries' => [
                'Count' => <integer>,
                'Percentage' => <float>,
            ],
            'InvalidValues' => [
                'Count' => <integer>,
                'Percentage' => <float>,
            ],
            'LargeTimestampGaps' => [
                'MaxTimestampGapInDays' => <integer>,
                'NumberOfLargeTimestampGaps' => <integer>,
                'Status' => 'POTENTIAL_ISSUE_DETECTED|NO_ISSUE_DETECTED',
            ],
            'MissingValues' => [
                'Count' => <integer>,
                'Percentage' => <float>,
            ],
            'MonotonicValues' => [
                'Monotonicity' => 'DECREASING|INCREASING|STATIC',
                'Status' => 'POTENTIAL_ISSUE_DETECTED|NO_ISSUE_DETECTED',
            ],
            'MultipleOperatingModes' => [
                'Status' => 'POTENTIAL_ISSUE_DETECTED|NO_ISSUE_DETECTED',
            ],
            'SensorName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ListTagsForResource

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

Lists all the tags for a specified resource, including key and value.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Creates a resource control policy for a given resource.

Parameter Syntax

$result = $client->putResourcePolicy([
    'ClientToken' => '<string>', // REQUIRED
    'PolicyRevisionId' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
    'ResourcePolicy' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PolicyRevisionId' => '<string>',
    'ResourceArn' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

StartDataIngestionJob

$result = $client->startDataIngestionJob([/* ... */]);
$promise = $client->startDataIngestionJobAsync([/* ... */]);

Starts a data ingestion job. Amazon Lookout for Equipment returns the job status.

Parameter Syntax

$result = $client->startDataIngestionJob([
    'ClientToken' => '<string>', // REQUIRED
    'DatasetName' => '<string>', // REQUIRED
    'IngestionInputConfiguration' => [ // REQUIRED
        'S3InputConfiguration' => [ // REQUIRED
            'Bucket' => '<string>', // REQUIRED
            'KeyPattern' => '<string>',
            'Prefix' => '<string>',
        ],
    ],
    'RoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'JobId' => '<string>',
    'Status' => 'IN_PROGRESS|SUCCESS|FAILED|IMPORT_IN_PROGRESS',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

StartInferenceScheduler

$result = $client->startInferenceScheduler([/* ... */]);
$promise = $client->startInferenceSchedulerAsync([/* ... */]);

Starts an inference scheduler.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'InferenceSchedulerArn' => '<string>',
    'InferenceSchedulerName' => '<string>',
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

StartRetrainingScheduler

$result = $client->startRetrainingScheduler([/* ... */]);
$promise = $client->startRetrainingSchedulerAsync([/* ... */]);

Starts a retraining scheduler.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Starts a retraining scheduler

$result = $client->startRetrainingScheduler([
    'ModelName' => 'sample-model',
]);

Result syntax:

[
    'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'ModelName' => 'sample-model',
    'Status' => 'PENDING',
]

StopInferenceScheduler

$result = $client->stopInferenceScheduler([/* ... */]);
$promise = $client->stopInferenceSchedulerAsync([/* ... */]);

Stops an inference scheduler.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'InferenceSchedulerArn' => '<string>',
    'InferenceSchedulerName' => '<string>',
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

StopRetrainingScheduler

$result = $client->stopRetrainingScheduler([/* ... */]);
$promise = $client->stopRetrainingSchedulerAsync([/* ... */]);

Stops a retraining scheduler.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'Status' => 'PENDING|RUNNING|STOPPING|STOPPED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Stops a retraining scheduler

$result = $client->stopRetrainingScheduler([
    'ModelName' => 'sample-model',
]);

Result syntax:

[
    'ModelArn' => 'arn:aws:lookoutequipment:us-east-1:123456789012:model/sample-model/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111',
    'ModelName' => 'sample-model',
    'Status' => 'STOPPING',
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associates a given tag to a resource in your account. A tag is a key-value pair which can be added to an Amazon Lookout for Equipment resource as metadata. Tags can be used for organizing your resources as well as helping you to search and filter by tag. Multiple tags can be added to a resource, either when you create it, or later. Up to 50 tags can be associated with each resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ServiceQuotaExceededException:

Resource limitations have been exceeded.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a specific tag from a given resource. The tag is specified by its key.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

UpdateActiveModelVersion

$result = $client->updateActiveModelVersion([/* ... */]);
$promise = $client->updateActiveModelVersionAsync([/* ... */]);

Sets the active model version for a given machine learning model.

Parameter Syntax

$result = $client->updateActiveModelVersion([
    'ModelName' => '<string>', // REQUIRED
    'ModelVersion' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CurrentActiveVersion' => <integer>,
    'CurrentActiveVersionArn' => '<string>',
    'ModelArn' => '<string>',
    'ModelName' => '<string>',
    'PreviousActiveVersion' => <integer>,
    'PreviousActiveVersionArn' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

UpdateInferenceScheduler

$result = $client->updateInferenceScheduler([/* ... */]);
$promise = $client->updateInferenceSchedulerAsync([/* ... */]);

Updates an inference scheduler.

Parameter Syntax

$result = $client->updateInferenceScheduler([
    'DataDelayOffsetInMinutes' => <integer>,
    'DataInputConfiguration' => [
        'InferenceInputNameConfiguration' => [
            'ComponentTimestampDelimiter' => '<string>',
            'TimestampFormat' => '<string>',
        ],
        'InputTimeZoneOffset' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'DataOutputConfiguration' => [
        'KmsKeyId' => '<string>',
        'S3OutputConfiguration' => [ // REQUIRED
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'DataUploadFrequency' => 'PT5M|PT10M|PT15M|PT30M|PT1H',
    'InferenceSchedulerName' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

UpdateLabelGroup

$result = $client->updateLabelGroup([/* ... */]);
$promise = $client->updateLabelGroupAsync([/* ... */]);

Updates the label group.

Parameter Syntax

$result = $client->updateLabelGroup([
    'FaultCodes' => ['<string>', ...],
    'LabelGroupName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

UpdateModel

$result = $client->updateModel([/* ... */]);
$promise = $client->updateModelAsync([/* ... */]);

Updates a model in the account.

Parameter Syntax

$result = $client->updateModel([
    'LabelsInputConfiguration' => [
        'LabelGroupName' => '<string>',
        'S3InputConfiguration' => [
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'ModelDiagnosticsOutputConfiguration' => [
        'KmsKeyId' => '<string>',
        'S3OutputConfiguration' => [ // REQUIRED
            'Bucket' => '<string>', // REQUIRED
            'Prefix' => '<string>',
        ],
    ],
    'ModelName' => '<string>', // REQUIRED
    'RoleArn' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Updates a model

$result = $client->updateModel([
    'LabelsInputConfiguration' => [
        'LabelGroupName' => 'sample-label-group',
    ],
    'ModelName' => 'sample-model',
]);

UpdateRetrainingScheduler

$result = $client->updateRetrainingScheduler([/* ... */]);
$promise = $client->updateRetrainingSchedulerAsync([/* ... */]);

Updates a retraining scheduler.

Parameter Syntax

$result = $client->updateRetrainingScheduler([
    'LookbackWindow' => '<string>',
    'ModelName' => '<string>', // REQUIRED
    'PromoteMode' => 'MANAGED|MANUAL',
    'RetrainingFrequency' => '<string>',
    'RetrainingStartDate' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

ResourceNotFoundException:

The resource requested could not be found. Verify the resource ID and retry your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the target resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

The request could not be completed because you do not have access to the resource.

InternalServerException:

Processing of the request has failed because of an unknown error, exception or failure.

Examples

Example 1: Updates a retraining scheduler

$result = $client->updateRetrainingScheduler([
    'ModelName' => 'sample-model',
    'RetrainingFrequency' => 'P1Y',
    'RetrainingStartDate' => ,
]);