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.

DescribeCompilationJobOutput

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

type DescribeCompilationJobOutput struct { CompilationEndTime *time.Time `type:"timestamp"` CompilationJobArn *string `type:"string" required:"true"` CompilationJobName *string `min:"1" type:"string" required:"true"` CompilationJobStatus *string `type:"string" required:"true" enum:"CompilationJobStatus"` CompilationStartTime *time.Time `type:"timestamp"` CreationTime *time.Time `type:"timestamp" required:"true"` FailureReason *string `type:"string" required:"true"` InputConfig *InputConfig `type:"structure" required:"true"` LastModifiedTime *time.Time `type:"timestamp" required:"true"` ModelArtifacts *ModelArtifacts `type:"structure" required:"true"` OutputConfig *OutputConfig `type:"structure" required:"true"` RoleArn *string `min:"20" type:"string" required:"true"` StoppingCondition *StoppingCondition `type:"structure" required:"true"` }

CompilationEndTime

Type: *time.Time

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

CompilationJobArn

Type: *string

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

CompilationJobArn is a required field

CompilationJobName

Type: *string

The name of the model compilation job.

CompilationJobName is a required field

CompilationJobStatus

Type: *string

The status of the model compilation job.

CompilationJobStatus is a required field

CompilationStartTime

Type: *time.Time

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

CreationTime

Type: *time.Time

The time that the model compilation job was created.

CreationTime is a required field

FailureReason

Type: *string

If a model compilation job failed, the reason it failed.

FailureReason is a required field

InputConfig

Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

LastModifiedTime

Type: *time.Time

The time that the status of the model compilation job was last modified.

LastModifiedTime is a required field

ModelArtifacts

Provides information about the location that is configured for storing model artifacts.

OutputConfig

Contains information about the output location for the compiled model and the device (target) that the model runs on.

RoleArn

Type: *string

The Amazon Resource Name (ARN) of the model compilation job.

RoleArn is a required field

StoppingCondition

Specifies how long model training can run. When model training reaches the limit, Amazon SageMaker ends the training job. Use this API to cap model training cost.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of training is not lost.

Training algorithms provided by Amazon SageMaker automatically saves the intermediate results of a model training job (it is best effort case, as model might not be ready to save as some stages, for example training just started). This intermediate data is a valid model artifact. You can use it to create a model (CreateModel).

Method

GoString

func (s DescribeCompilationJobOutput) GoString() string

GoString returns the string representation

SetCompilationEndTime

func (s *DescribeCompilationJobOutput) SetCompilationEndTime(v time.Time) *DescribeCompilationJobOutput

SetCompilationEndTime sets the CompilationEndTime field's value.

SetCompilationJobArn

func (s *DescribeCompilationJobOutput) SetCompilationJobArn(v string) *DescribeCompilationJobOutput

SetCompilationJobArn sets the CompilationJobArn field's value.

SetCompilationJobName

func (s *DescribeCompilationJobOutput) SetCompilationJobName(v string) *DescribeCompilationJobOutput

SetCompilationJobName sets the CompilationJobName field's value.

SetCompilationJobStatus

func (s *DescribeCompilationJobOutput) SetCompilationJobStatus(v string) *DescribeCompilationJobOutput

SetCompilationJobStatus sets the CompilationJobStatus field's value.

SetCompilationStartTime

func (s *DescribeCompilationJobOutput) SetCompilationStartTime(v time.Time) *DescribeCompilationJobOutput

SetCompilationStartTime sets the CompilationStartTime field's value.

SetCreationTime

func (s *DescribeCompilationJobOutput) SetCreationTime(v time.Time) *DescribeCompilationJobOutput

SetCreationTime sets the CreationTime field's value.

SetFailureReason

func (s *DescribeCompilationJobOutput) SetFailureReason(v string) *DescribeCompilationJobOutput

SetFailureReason sets the FailureReason field's value.

SetInputConfig

func (s *DescribeCompilationJobOutput) SetInputConfig(v *InputConfig) *DescribeCompilationJobOutput

SetInputConfig sets the InputConfig field's value.

SetLastModifiedTime

func (s *DescribeCompilationJobOutput) SetLastModifiedTime(v time.Time) *DescribeCompilationJobOutput

SetLastModifiedTime sets the LastModifiedTime field's value.

SetModelArtifacts

func (s *DescribeCompilationJobOutput) SetModelArtifacts(v *ModelArtifacts) *DescribeCompilationJobOutput

SetModelArtifacts sets the ModelArtifacts field's value.

SetOutputConfig

func (s *DescribeCompilationJobOutput) SetOutputConfig(v *OutputConfig) *DescribeCompilationJobOutput

SetOutputConfig sets the OutputConfig field's value.

SetRoleArn

func (s *DescribeCompilationJobOutput) SetRoleArn(v string) *DescribeCompilationJobOutput

SetRoleArn sets the RoleArn field's value.

SetStoppingCondition

func (s *DescribeCompilationJobOutput) SetStoppingCondition(v *StoppingCondition) *DescribeCompilationJobOutput

SetStoppingCondition sets the StoppingCondition field's value.

String

func (s DescribeCompilationJobOutput) String() string

String returns the string representation

On this page: