LookoutEquipment / Client / describe_inference_scheduler

describe_inference_scheduler#

LookoutEquipment.Client.describe_inference_scheduler(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.describe_inference_scheduler(
    InferenceSchedulerName='string'
)
Parameters:

InferenceSchedulerName (string) –

[REQUIRED]

The name of the inference scheduler being described.

Return type:

dict

Returns:

Response Syntax

{
    'ModelArn': 'string',
    'ModelName': 'string',
    'InferenceSchedulerName': 'string',
    'InferenceSchedulerArn': 'string',
    'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED',
    'DataDelayOffsetInMinutes': 123,
    'DataUploadFrequency': 'PT5M'|'PT10M'|'PT15M'|'PT30M'|'PT1H',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'DataInputConfiguration': {
        'S3InputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'InputTimeZoneOffset': 'string',
        'InferenceInputNameConfiguration': {
            'TimestampFormat': 'string',
            'ComponentTimestampDelimiter': 'string'
        }
    },
    'DataOutputConfiguration': {
        'S3OutputConfiguration': {
            'Bucket': 'string',
            'Prefix': 'string'
        },
        'KmsKeyId': 'string'
    },
    'RoleArn': 'string',
    'ServerSideKmsKeyId': 'string',
    'LatestInferenceResult': 'ANOMALOUS'|'NORMAL'
}

Response Structure

  • (dict) –

    • ModelArn (string) –

      The Amazon Resource Name (ARN) of the machine learning model of the inference scheduler being described.

    • ModelName (string) –

      The name of the machine learning model of the inference scheduler being described.

    • InferenceSchedulerName (string) –

      The name of the inference scheduler being described.

    • InferenceSchedulerArn (string) –

      The Amazon Resource Name (ARN) of the inference scheduler being described.

    • Status (string) –

      Indicates the status of the inference scheduler.

    • DataDelayOffsetInMinutes (integer) –

      A period of time (in minutes) by which inference on the data is delayed after the data starts. For instance, if you select an offset delay time of five minutes, inference will not begin on the data until the first data measurement after the five minute mark. For example, if five minutes is selected, the inference scheduler will wake up at the configured frequency with the additional five minute delay time to check the customer S3 bucket. The customer can upload data at the same frequency and they don’t need to stop and restart the scheduler when uploading new data.

    • DataUploadFrequency (string) –

      Specifies how often data is uploaded to the source S3 bucket for the input data. This value is the length of time between data uploads. For instance, if you select 5 minutes, Amazon Lookout for Equipment will upload the real-time data to the source bucket once every 5 minutes. This frequency also determines how often Amazon Lookout for Equipment starts a scheduled inference on your data. In this example, it starts once every 5 minutes.

    • CreatedAt (datetime) –

      Specifies the time at which the inference scheduler was created.

    • UpdatedAt (datetime) –

      Specifies the time at which the inference scheduler was last updated, if it was.

    • DataInputConfiguration (dict) –

      Specifies configuration information for the input data for the inference scheduler, including delimiter, format, and dataset location.

      • S3InputConfiguration (dict) –

        Specifies configuration information for the input data for the inference, including Amazon S3 location of input data.

        • Bucket (string) –

          The bucket containing the input dataset for the inference.

        • Prefix (string) –

          The prefix for the S3 bucket used for the input data for the inference.

      • InputTimeZoneOffset (string) –

        Indicates the difference between your time zone and Coordinated Universal Time (UTC).

      • InferenceInputNameConfiguration (dict) –

        Specifies configuration information for the input data for the inference, including timestamp format and delimiter.

        • TimestampFormat (string) –

          The format of the timestamp, whether Epoch time, or standard, with or without hyphens (-).

        • ComponentTimestampDelimiter (string) –

          Indicates the delimiter character used between items in the data.

    • DataOutputConfiguration (dict) –

      Specifies information for the output results for the inference scheduler, including the output S3 location.

      • S3OutputConfiguration (dict) –

        Specifies configuration information for the output results from for the inference, output S3 location.

        • Bucket (string) –

          The bucket containing the output results from the inference

        • Prefix (string) –

          The prefix for the S3 bucket used for the output results from the inference.

      • KmsKeyId (string) –

        The ID number for the KMS key key used to encrypt the inference output.

    • RoleArn (string) –

      The Amazon Resource Name (ARN) of a role with permission to access the data source for the inference scheduler being described.

    • ServerSideKmsKeyId (string) –

      Provides the identifier of the KMS key used to encrypt inference scheduler data by Amazon Lookout for Equipment.

    • LatestInferenceResult (string) –

      Indicates whether the latest execution for the inference scheduler was Anomalous (anomalous events found) or Normal (no anomalous events found).

Exceptions