ModelCardExportJob class
Manage an Amazon SageMaker Model Card export job.
Example Usage
Basic usage:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.sagemaker.ModelCardExportJob("example", {
outputConfig: {
s3OutputPath: `s3://${test.example}/`,
},
modelCardExportJobName: "my-model-card-export-job",
modelCardName: exampleAwsSagemakerModelCard.modelCardName,
});
import pulumi
import pulumi_aws as aws
example = aws.sagemaker.ModelCardExportJob("example",
output_config={
"s3_output_path": f"s3://{test['example']}/",
},
model_card_export_job_name="my-model-card-export-job",
model_card_name=example_aws_sagemaker_model_card["modelCardName"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Sagemaker.ModelCardExportJob("example", new()
{
OutputConfig = new Aws.Sagemaker.Inputs.ModelCardExportJobOutputConfigArgs
{
S3OutputPath = $"s3://{test.Example}/",
},
ModelCardExportJobName = "my-model-card-export-job",
ModelCardName = exampleAwsSagemakerModelCard.ModelCardName,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sagemaker"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := sagemaker.NewModelCardExportJob(ctx, "example", &sagemaker.ModelCardExportJobArgs{
OutputConfig: &sagemaker.ModelCardExportJobOutputConfigArgs{
S3OutputPath: pulumi.Sprintf("s3://%v/", test.Example),
},
ModelCardExportJobName: pulumi.String("my-model-card-export-job"),
ModelCardName: pulumi.Any(exampleAwsSagemakerModelCard.ModelCardName),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_sagemaker_modelcardexportjob" "example" {
output_config = {
s3_output_path ="s3://${test.example}/"
}
model_card_export_job_name = "my-model-card-export-job"
model_card_name = exampleAwsSagemakerModelCard.modelCardName
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sagemaker.ModelCardExportJob;
import com.pulumi.aws.sagemaker.ModelCardExportJobArgs;
import com.pulumi.aws.sagemaker.inputs.ModelCardExportJobOutputConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new ModelCardExportJob("example", ModelCardExportJobArgs.builder()
.outputConfig(ModelCardExportJobOutputConfigArgs.builder()
.s3OutputPath(String.format("s3://%s/", test.example()))
.build())
.modelCardExportJobName("my-model-card-export-job")
.modelCardName(exampleAwsSagemakerModelCard.modelCardName())
.build());
}
}
resources:
example:
type: aws:sagemaker:ModelCardExportJob
properties:
outputConfig:
s3OutputPath: s3://${test.example}/
modelCardExportJobName: my-model-card-export-job
modelCardName: ${exampleAwsSagemakerModelCard.modelCardName}
Import
Using pulumi import, import model card export jobs using the modelCardExportJobArn. For example:
$ pulumi import aws:sagemaker/modelCardExportJob:ModelCardExportJob example arn:aws:sagemaker:us-west-2:123456789012:model-card/my-model-card/export-job/my-model-card-export-job
Constructors
- ModelCardExportJob(String name, {ModelCardExportJobArgs? args, CustomResourceOptions? options})
-
Creates a new ModelCardExportJob.
nameThe Pulumi resource name.argsArguments used to configure this ModelCardExportJob. The set of arguments for ModelCardExportJob.optionsResource options controlling this resource's behavior. - ModelCardExportJob.reference(String urn)
- Creates a typed reference to an existing ModelCardExportJob resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
exportArtifacts
↔ Output<
List< ModelCardExportJobExportArtifact> > -
Exported model card artifacts.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
modelCardExportJobArn
↔ Output<
String> -
ARN of the model card export job.
latefinal
-
modelCardExportJobName
↔ Output<
String> -
Name of the model card export job.
latefinal
-
modelCardName
↔ Output<
String> -
Name of the model card.
latefinal
-
modelCardVersion
↔ Output<
int> -
latefinal
-
outputConfig
↔ Output<
ModelCardExportJobOutputConfig> -
Export output details. Fields are documented below.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeouts
↔ Output<
ModelCardExportJobTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ModelCardExportJobState? state, CustomResourceOptions? options}) → ModelCardExportJob -
Gets an existing ModelCardExportJob resource's state with the given
nameandid.