Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. cleanrooms
  5. getAnalysisTemplate

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.cleanrooms.getAnalysisTemplate

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

    Represents a stored analysis within a collaboration

    Using getAnalysisTemplate

    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 getAnalysisTemplate(args: GetAnalysisTemplateArgs, opts?: InvokeOptions): Promise<GetAnalysisTemplateResult>
function getAnalysisTemplateOutput(args: GetAnalysisTemplateOutputArgs, opts?: InvokeOptions): Output<GetAnalysisTemplateResult>
    def get_analysis_template(analysis_template_identifier: Optional[str] = None,
                          membership_identifier: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAnalysisTemplateResult
def get_analysis_template_output(analysis_template_identifier: Optional[pulumi.Input[str]] = None,
                          membership_identifier: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAnalysisTemplateResult]
    func LookupAnalysisTemplate(ctx *Context, args *LookupAnalysisTemplateArgs, opts ...InvokeOption) (*LookupAnalysisTemplateResult, error)
func LookupAnalysisTemplateOutput(ctx *Context, args *LookupAnalysisTemplateOutputArgs, opts ...InvokeOption) LookupAnalysisTemplateResultOutput

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

    public static class GetAnalysisTemplate 
{
    public static Task<GetAnalysisTemplateResult> InvokeAsync(GetAnalysisTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetAnalysisTemplateResult> Invoke(GetAnalysisTemplateInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAnalysisTemplateResult> getAnalysisTemplate(GetAnalysisTemplateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:cleanrooms:getAnalysisTemplate
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AnalysisTemplateIdentifier string

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    MembershipIdentifier string
    The identifier for a membership resource.
    AnalysisTemplateIdentifier string

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    MembershipIdentifier string
    The identifier for a membership resource.
    analysisTemplateIdentifier String

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    membershipIdentifier String
    The identifier for a membership resource.
    analysisTemplateIdentifier string

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    membershipIdentifier string
    The identifier for a membership resource.
    analysis_template_identifier str

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    membership_identifier str
    The identifier for a membership resource.
    analysisTemplateIdentifier String

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    membershipIdentifier String
    The identifier for a membership resource.

    getAnalysisTemplate Result

    The following output properties are available:

    AnalysisTemplateIdentifier string

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    Arn string

    Returns the Amazon Resource Name (ARN) of the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    CollaborationArn string

    Returns the unique ARN for the analysis template’s associated collaboration.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    CollaborationIdentifier string

    Returns the unique ID for the associated collaboration of the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    Description string
    The description of the analysis template.
    MembershipArn string

    Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

    Schema Pulumi.AwsNative.CleanRooms.Outputs.AnalysisTemplateAnalysisSchema
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
    AnalysisTemplateIdentifier string

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    Arn string

    Returns the Amazon Resource Name (ARN) of the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    CollaborationArn string

    Returns the unique ARN for the analysis template’s associated collaboration.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    CollaborationIdentifier string

    Returns the unique ID for the associated collaboration of the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    Description string
    The description of the analysis template.
    MembershipArn string

    Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

    Schema AnalysisTemplateAnalysisSchema
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
    analysisTemplateIdentifier String

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    arn String

    Returns the Amazon Resource Name (ARN) of the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    collaborationArn String

    Returns the unique ARN for the analysis template’s associated collaboration.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    collaborationIdentifier String

    Returns the unique ID for the associated collaboration of the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    description String
    The description of the analysis template.
    membershipArn String

    Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

    schema AnalysisTemplateAnalysisSchema
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
    analysisTemplateIdentifier string

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    arn string

    Returns the Amazon Resource Name (ARN) of the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    collaborationArn string

    Returns the unique ARN for the analysis template’s associated collaboration.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    collaborationIdentifier string

    Returns the unique ID for the associated collaboration of the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    description string
    The description of the analysis template.
    membershipArn string

    Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

    schema AnalysisTemplateAnalysisSchema
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
    analysis_template_identifier str

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    arn str

    Returns the Amazon Resource Name (ARN) of the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    collaboration_arn str

    Returns the unique ARN for the analysis template’s associated collaboration.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    collaboration_identifier str

    Returns the unique ID for the associated collaboration of the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    description str
    The description of the analysis template.
    membership_arn str

    Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

    schema AnalysisTemplateAnalysisSchema
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.
    analysisTemplateIdentifier String

    Returns the identifier for the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    arn String

    Returns the Amazon Resource Name (ARN) of the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/analysistemplates/a1b2c3d4-5678-90ab-cdef-EXAMPLE2222

    collaborationArn String

    Returns the unique ARN for the analysis template’s associated collaboration.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:collaboration/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    collaborationIdentifier String

    Returns the unique ID for the associated collaboration of the analysis template.

    Example: a1b2c3d4-5678-90ab-cdef-EXAMPLE33333

    description String
    The description of the analysis template.
    membershipArn String

    Returns the Amazon Resource Name (ARN) of the member who created the analysis template.

    Example: arn:aws:cleanrooms:us-east-1:111122223333:membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

    schema Property Map
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this cleanrooms analysis template.

    Supporting Types

    AnalysisTemplateAnalysisSchema

    ReferencedTables List<string>
    The tables referenced in the analysis schema.
    ReferencedTables []string
    The tables referenced in the analysis schema.
    referencedTables List<String>
    The tables referenced in the analysis schema.
    referencedTables string[]
    The tables referenced in the analysis schema.
    referenced_tables Sequence[str]
    The tables referenced in the analysis schema.
    referencedTables List<String>
    The tables referenced in the analysis schema.

    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