Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. sagemaker
  5. getPipeline

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.sagemaker.getPipeline

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::Pipeline

    Using getPipeline

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>
    def get_pipeline(pipeline_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(pipeline_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]
    func LookupPipeline(ctx *Context, args *LookupPipelineArgs, opts ...InvokeOption) (*LookupPipelineResult, error)
func LookupPipelineOutput(ctx *Context, args *LookupPipelineOutputArgs, opts ...InvokeOption) LookupPipelineResultOutput

    > Note: This function is named LookupPipeline in the Go SDK.

    public static class GetPipeline 
{
    public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:sagemaker:getPipeline
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PipelineName string
    The name of the Pipeline.
    PipelineName string
    The name of the Pipeline.
    pipelineName String
    The name of the Pipeline.
    pipelineName string
    The name of the Pipeline.
    pipeline_name str
    The name of the Pipeline.
    pipelineName String
    The name of the Pipeline.

    getPipeline Result

    The following output properties are available:

    ParallelismConfiguration Pulumi.AwsNative.SageMaker.Outputs.ParallelismConfigurationProperties
    The parallelism configuration applied to the pipeline.
    PipelineDefinition Pulumi.AwsNative.SageMaker.Outputs.PipelineDefinition0Properties | Pulumi.AwsNative.SageMaker.Outputs.PipelineDefinition1Properties
    The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.
    PipelineDescription string
    The description of the Pipeline.
    PipelineDisplayName string
    The display name of the Pipeline.
    RoleArn string
    Role Arn
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags of the pipeline.
    ParallelismConfiguration ParallelismConfigurationProperties
    The parallelism configuration applied to the pipeline.
    PipelineDefinition PipelineDefinition0Properties | PipelineDefinition1Properties
    The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.
    PipelineDescription string
    The description of the Pipeline.
    PipelineDisplayName string
    The display name of the Pipeline.
    RoleArn string
    Role Arn
    Tags Tag
    The tags of the pipeline.
    parallelismConfiguration ParallelismConfigurationProperties
    The parallelism configuration applied to the pipeline.
    pipelineDefinition PipelineDefinition0Properties | PipelineDefinition1Properties
    The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.
    pipelineDescription String
    The description of the Pipeline.
    pipelineDisplayName String
    The display name of the Pipeline.
    roleArn String
    Role Arn
    tags List<Tag>
    The tags of the pipeline.
    parallelismConfiguration ParallelismConfigurationProperties
    The parallelism configuration applied to the pipeline.
    pipelineDefinition PipelineDefinition0Properties | PipelineDefinition1Properties
    The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.
    pipelineDescription string
    The description of the Pipeline.
    pipelineDisplayName string
    The display name of the Pipeline.
    roleArn string
    Role Arn
    tags Tag[]
    The tags of the pipeline.
    parallelism_configuration ParallelismConfigurationProperties
    The parallelism configuration applied to the pipeline.
    pipeline_definition PipelineDefinition0Properties | PipelineDefinition1Properties
    The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.
    pipeline_description str
    The description of the Pipeline.
    pipeline_display_name str
    The display name of the Pipeline.
    role_arn str
    Role Arn
    tags Sequence[root_Tag]
    The tags of the pipeline.
    parallelismConfiguration Property Map
    The parallelism configuration applied to the pipeline.
    pipelineDefinition Property Map | Property Map
    The definition of the pipeline. This can be either a JSON string or an Amazon S3 location.
    pipelineDescription String
    The description of the Pipeline.
    pipelineDisplayName String
    The display name of the Pipeline.
    roleArn String
    Role Arn
    tags List<Property Map>
    The tags of the pipeline.

    Supporting Types

    ParallelismConfigurationProperties

    MaxParallelExecutionSteps int
    Maximum parallel execution steps
    MaxParallelExecutionSteps int
    Maximum parallel execution steps
    maxParallelExecutionSteps Integer
    Maximum parallel execution steps
    maxParallelExecutionSteps number
    Maximum parallel execution steps
    max_parallel_execution_steps int
    Maximum parallel execution steps
    maxParallelExecutionSteps Number
    Maximum parallel execution steps

    PipelineDefinition0Properties

    PipelineDefinitionBody string
    A specification that defines the pipeline in JSON format.
    PipelineDefinitionBody string
    A specification that defines the pipeline in JSON format.
    pipelineDefinitionBody String
    A specification that defines the pipeline in JSON format.
    pipelineDefinitionBody string
    A specification that defines the pipeline in JSON format.
    pipeline_definition_body str
    A specification that defines the pipeline in JSON format.
    pipelineDefinitionBody String
    A specification that defines the pipeline in JSON format.

    PipelineDefinition1Properties

    PipelineS3Location

    Bucket string
    The name of the S3 bucket where the PipelineDefinition file is stored.
    Key string
    The file name of the PipelineDefinition file (Amazon S3 object name).
    ETag string
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    Version string
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    Bucket string
    The name of the S3 bucket where the PipelineDefinition file is stored.
    Key string
    The file name of the PipelineDefinition file (Amazon S3 object name).
    ETag string
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    Version string
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket String
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key String
    The file name of the PipelineDefinition file (Amazon S3 object name).
    eTag String
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version String
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket string
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key string
    The file name of the PipelineDefinition file (Amazon S3 object name).
    eTag string
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version string
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket str
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key str
    The file name of the PipelineDefinition file (Amazon S3 object name).
    e_tag str
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version str
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.
    bucket String
    The name of the S3 bucket where the PipelineDefinition file is stored.
    key String
    The file name of the PipelineDefinition file (Amazon S3 object name).
    eTag String
    The Amazon S3 ETag (a file checksum) of the PipelineDefinition file. If you don't specify a value, SageMaker skips ETag validation of your PipelineDefinition file.
    version String
    For versioning-enabled buckets, a specific version of the PipelineDefinition file.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native