AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetBatchPredictionOutput

import "github.com/aws/aws-sdk-go/service/machinelearning"

type GetBatchPredictionOutput struct { BatchPredictionDataSourceId *string `min:"1" type:"string"` BatchPredictionId *string `min:"1" type:"string"` ComputeTime *int64 `type:"long"` CreatedAt *time.Time `type:"timestamp"` CreatedByIamUser *string `type:"string"` FinishedAt *time.Time `type:"timestamp"` InputDataLocationS3 *string `type:"string"` InvalidRecordCount *int64 `type:"long"` LastUpdatedAt *time.Time `type:"timestamp"` LogUri *string `type:"string"` MLModelId *string `min:"1" type:"string"` Message *string `type:"string"` Name *string `type:"string"` OutputUri *string `type:"string"` StartedAt *time.Time `type:"timestamp"` Status *string `type:"string" enum:"EntityStatus"` TotalRecordCount *int64 `type:"long"` }

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

BatchPredictionDataSourceId

Type: *string

The ID of the DataSource that was used to create the BatchPrediction.

BatchPredictionId

Type: *string

An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

ComputeTime

Type: *int64

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

CreatedAt

Type: *time.Time

The time when the BatchPrediction was created. The time is expressed in epoch time.

CreatedByIamUser

Type: *string

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

FinishedAt

Type: *time.Time

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

InputDataLocationS3

Type: *string

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

InvalidRecordCount

Type: *int64

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

LastUpdatedAt

Type: *time.Time

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

LogUri

Type: *string

A link to the file that contains logs of the CreateBatchPrediction operation.

MLModelId

Type: *string

The ID of the MLModel that generated predictions for the BatchPrediction request.

Message

Type: *string

A description of the most recent details about processing the batch prediction request.

Name

Type: *string

A user-supplied name or description of the BatchPrediction.

OutputUri

Type: *string

The location of an Amazon S3 bucket or directory to receive the operation results.

StartedAt

Type: *time.Time

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

Status

Type: *string

The status of the BatchPrediction, which can be one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.

  • INPROGRESS - The batch predictions are in progress.

  • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.

  • COMPLETED - The batch prediction process completed successfully.

  • DELETED - The BatchPrediction is marked as deleted. It is not usable.

TotalRecordCount

Type: *int64

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

Method

GoString

func (s GetBatchPredictionOutput) GoString() string

GoString returns the string representation

SetBatchPredictionDataSourceId

func (s *GetBatchPredictionOutput) SetBatchPredictionDataSourceId(v string) *GetBatchPredictionOutput

SetBatchPredictionDataSourceId sets the BatchPredictionDataSourceId field's value.

SetBatchPredictionId

func (s *GetBatchPredictionOutput) SetBatchPredictionId(v string) *GetBatchPredictionOutput

SetBatchPredictionId sets the BatchPredictionId field's value.

SetComputeTime

func (s *GetBatchPredictionOutput) SetComputeTime(v int64) *GetBatchPredictionOutput

SetComputeTime sets the ComputeTime field's value.

SetCreatedAt

func (s *GetBatchPredictionOutput) SetCreatedAt(v time.Time) *GetBatchPredictionOutput

SetCreatedAt sets the CreatedAt field's value.

SetCreatedByIamUser

func (s *GetBatchPredictionOutput) SetCreatedByIamUser(v string) *GetBatchPredictionOutput

SetCreatedByIamUser sets the CreatedByIamUser field's value.

SetFinishedAt

func (s *GetBatchPredictionOutput) SetFinishedAt(v time.Time) *GetBatchPredictionOutput

SetFinishedAt sets the FinishedAt field's value.

SetInputDataLocationS3

func (s *GetBatchPredictionOutput) SetInputDataLocationS3(v string) *GetBatchPredictionOutput

SetInputDataLocationS3 sets the InputDataLocationS3 field's value.

SetInvalidRecordCount

func (s *GetBatchPredictionOutput) SetInvalidRecordCount(v int64) *GetBatchPredictionOutput

SetInvalidRecordCount sets the InvalidRecordCount field's value.

SetLastUpdatedAt

func (s *GetBatchPredictionOutput) SetLastUpdatedAt(v time.Time) *GetBatchPredictionOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

SetLogUri

func (s *GetBatchPredictionOutput) SetLogUri(v string) *GetBatchPredictionOutput

SetLogUri sets the LogUri field's value.

SetMLModelId

func (s *GetBatchPredictionOutput) SetMLModelId(v string) *GetBatchPredictionOutput

SetMLModelId sets the MLModelId field's value.

SetMessage

func (s *GetBatchPredictionOutput) SetMessage(v string) *GetBatchPredictionOutput

SetMessage sets the Message field's value.

SetName

func (s *GetBatchPredictionOutput) SetName(v string) *GetBatchPredictionOutput

SetName sets the Name field's value.

SetOutputUri

func (s *GetBatchPredictionOutput) SetOutputUri(v string) *GetBatchPredictionOutput

SetOutputUri sets the OutputUri field's value.

SetStartedAt

func (s *GetBatchPredictionOutput) SetStartedAt(v time.Time) *GetBatchPredictionOutput

SetStartedAt sets the StartedAt field's value.

SetStatus

func (s *GetBatchPredictionOutput) SetStatus(v string) *GetBatchPredictionOutput

SetStatus sets the Status field's value.

SetTotalRecordCount

func (s *GetBatchPredictionOutput) SetTotalRecordCount(v int64) *GetBatchPredictionOutput

SetTotalRecordCount sets the TotalRecordCount field's value.

String

func (s GetBatchPredictionOutput) String() string

String returns the string representation

On this page: