1. Packages
  2. AWS Classic
  3. API Docs
  4. quicksight
  5. getQuicksightGroup

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

aws.quicksight.getQuicksightGroup

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi

    This data source can be used to fetch information about a specific QuickSight group. By using this data source, you can reference QuickSight group properties without having to hard code ARNs or unique IDs as input.

    Example Usage

    Basic Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Quicksight.GetQuicksightGroup.Invoke(new()
        {
            GroupName = "example",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := quicksight.GetQuicksightGroup(ctx, &quicksight.GetQuicksightGroupArgs{
    			GroupName: "example",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.quicksight.QuicksightFunctions;
    import com.pulumi.aws.quicksight.inputs.GetQuicksightGroupArgs;
    import java.util.List;
    import java.util.ArrayList;
    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) {
            final var example = QuicksightFunctions.getQuicksightGroup(GetQuicksightGroupArgs.builder()
                .groupName("example")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.quicksight.get_quicksight_group(group_name="example")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.quicksight.getQuicksightGroup({
        groupName: "example",
    });
    
    variables:
      example:
        fn::invoke:
          Function: aws:quicksight:getQuicksightGroup
          Arguments:
            groupName: example
    

    Using getQuicksightGroup

    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 getQuicksightGroup(args: GetQuicksightGroupArgs, opts?: InvokeOptions): Promise<GetQuicksightGroupResult>
    function getQuicksightGroupOutput(args: GetQuicksightGroupOutputArgs, opts?: InvokeOptions): Output<GetQuicksightGroupResult>
    def get_quicksight_group(aws_account_id: Optional[str] = None,
                             group_name: Optional[str] = None,
                             namespace: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetQuicksightGroupResult
    def get_quicksight_group_output(aws_account_id: Optional[pulumi.Input[str]] = None,
                             group_name: Optional[pulumi.Input[str]] = None,
                             namespace: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetQuicksightGroupResult]
    func GetQuicksightGroup(ctx *Context, args *GetQuicksightGroupArgs, opts ...InvokeOption) (*GetQuicksightGroupResult, error)
    func GetQuicksightGroupOutput(ctx *Context, args *GetQuicksightGroupOutputArgs, opts ...InvokeOption) GetQuicksightGroupResultOutput

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

    public static class GetQuicksightGroup 
    {
        public static Task<GetQuicksightGroupResult> InvokeAsync(GetQuicksightGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetQuicksightGroupResult> Invoke(GetQuicksightGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetQuicksightGroupResult> getQuicksightGroup(GetQuicksightGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:quicksight/getQuicksightGroup:getQuicksightGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GroupName string

    The name of the group that you want to match.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID.
    Namespace string
    QuickSight namespace. Defaults to default.
    GroupName string

    The name of the group that you want to match.

    The following arguments are optional:

    AwsAccountId string
    AWS account ID.
    Namespace string
    QuickSight namespace. Defaults to default.
    groupName String

    The name of the group that you want to match.

    The following arguments are optional:

    awsAccountId String
    AWS account ID.
    namespace String
    QuickSight namespace. Defaults to default.
    groupName string

    The name of the group that you want to match.

    The following arguments are optional:

    awsAccountId string
    AWS account ID.
    namespace string
    QuickSight namespace. Defaults to default.
    group_name str

    The name of the group that you want to match.

    The following arguments are optional:

    aws_account_id str
    AWS account ID.
    namespace str
    QuickSight namespace. Defaults to default.
    groupName String

    The name of the group that you want to match.

    The following arguments are optional:

    awsAccountId String
    AWS account ID.
    namespace String
    QuickSight namespace. Defaults to default.

    getQuicksightGroup Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) for the group.
    AwsAccountId string
    Description string
    The group description.
    GroupName string
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalId string
    The principal ID of the group.
    Namespace string
    Arn string
    The Amazon Resource Name (ARN) for the group.
    AwsAccountId string
    Description string
    The group description.
    GroupName string
    Id string
    The provider-assigned unique ID for this managed resource.
    PrincipalId string
    The principal ID of the group.
    Namespace string
    arn String
    The Amazon Resource Name (ARN) for the group.
    awsAccountId String
    description String
    The group description.
    groupName String
    id String
    The provider-assigned unique ID for this managed resource.
    principalId String
    The principal ID of the group.
    namespace String
    arn string
    The Amazon Resource Name (ARN) for the group.
    awsAccountId string
    description string
    The group description.
    groupName string
    id string
    The provider-assigned unique ID for this managed resource.
    principalId string
    The principal ID of the group.
    namespace string
    arn str
    The Amazon Resource Name (ARN) for the group.
    aws_account_id str
    description str
    The group description.
    group_name str
    id str
    The provider-assigned unique ID for this managed resource.
    principal_id str
    The principal ID of the group.
    namespace str
    arn String
    The Amazon Resource Name (ARN) for the group.
    awsAccountId String
    description String
    The group description.
    groupName String
    id String
    The provider-assigned unique ID for this managed resource.
    principalId String
    The principal ID of the group.
    namespace String

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.24.0 published on Tuesday, Feb 27, 2024 by Pulumi