NAME

Paws::Quicksight::CreateAnalysis - Arguments for method CreateAnalysis on Paws::Quicksight

DESCRIPTION

This class represents the parameters used for calling the method CreateAnalysis on the Amazon QuickSight service. Use the attributes of this class as arguments to method CreateAnalysis.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAnalysis.

SYNOPSIS

    my $quicksight = Paws->service('Quicksight');
    my $CreateAnalysisResponse = $quicksight->CreateAnalysis(
      AnalysisId   => 'MyRestrictiveResourceId',
      AwsAccountId => 'MyAwsAccountId',
      Name         => 'MyAnalysisName',
      SourceEntity => {
        SourceTemplate => {
          Arn               => 'MyArn',
          DataSetReferences => [
            {
              DataSetArn         => 'MyArn',
              DataSetPlaceholder => 'MyNonEmptyString',
            },
            ...
          ],    # min: 1
        },    # OPTIONAL
      },
      Parameters => {
        DateTimeParameters => [
          {
            Name   => 'MyNonEmptyString',
            Values => [ '1970-01-01T01:00:00', ... ],
          },
          ...
        ],    # max: 100; OPTIONAL
        DecimalParameters => [
          {
            Name   => 'MyNonEmptyString',
            Values => [ 1, ... ],
          },
          ...
        ],    # max: 100; OPTIONAL
        IntegerParameters => [
          {
            Name   => 'MyNonEmptyString',
            Values => [ 1, ... ],
          },
          ...
        ],    # max: 100; OPTIONAL
        StringParameters => [
          {
            Name   => 'MyNonEmptyString',
            Values => [ 'MyString', ... ],
          },
          ...
        ],    # max: 100; OPTIONAL
      },    # OPTIONAL
      Permissions => [
        {
          Actions   => [ 'MyString', ... ],    # min: 1, max: 16
          Principal => 'MyPrincipal',          # min: 1, max: 256
        },
        ...
      ],    # OPTIONAL
      Tags => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # min: 1, max: 256
        },
        ...
      ],    # OPTIONAL
      ThemeArn => 'MyArn',    # OPTIONAL
    );
    # Results:
    my $AnalysisId     = $CreateAnalysisResponse->AnalysisId;
    my $Arn            = $CreateAnalysisResponse->Arn;
    my $CreationStatus = $CreateAnalysisResponse->CreationStatus;
    my $RequestId      = $CreateAnalysisResponse->RequestId;
    my $Status         = $CreateAnalysisResponse->Status;
    # Returns a L<Paws::Quicksight::CreateAnalysisResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/quicksight/CreateAnalysis>

ATTRIBUTES

REQUIRED AnalysisId => Str

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

REQUIRED AwsAccountId => Str

The ID of the AWS account where you are creating an analysis.

REQUIRED Name => Str

A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.

Parameters => Paws::Quicksight::Parameters

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Permissions => ArrayRef[Paws::Quicksight::ResourcePermission]

A structure that describes the principals and the resource-level permissions on an analysis. You can use the "Permissions" structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit "Permissions".

REQUIRED SourceEntity => Paws::Quicksight::AnalysisSourceEntity

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Tags => ArrayRef[Paws::Quicksight::Tag]

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

ThemeArn => Str

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>