Amazon QuickSight 2018-04-01

CancelIngestion

$result = $client->cancelIngestion([/* ... */]);
$promise = $client->cancelIngestionAsync([/* ... */]);

Parameter Syntax

$result = $client->cancelIngestion([
    'AwsAccountId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'IngestionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'IngestionId' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• ResourceExistsException:

  The resource specified already exists.

• InternalFailureException:

  An internal failure occurred.

CreateAccountCustomization

$result = $client->createAccountCustomization([/* ... */]);
$promise = $client->createAccountCustomizationAsync([/* ... */]);

Parameter Syntax

$result = $client->createAccountCustomization([
    'AccountCustomization' => [ // REQUIRED
        'DefaultTheme' => '<string>',
    ],
    'AwsAccountId' => '<string>', // REQUIRED
    'Namespace' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AccountCustomization' => [
        'DefaultTheme' => '<string>',
    ],
    'AwsAccountId' => '<string>',
    'Namespace' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

CreateDashboard

$result = $client->createDashboard([/* ... */]);
$promise = $client->createDashboardAsync([/* ... */]);

Parameter Syntax

$result = $client->createDashboard([
    'AwsAccountId' => '<string>', // REQUIRED
    'DashboardId' => '<string>', // REQUIRED
    'DashboardPublishOptions' => [
        'AdHocFilteringOption' => [
            'AvailabilityStatus' => 'ENABLED|DISABLED',
        ],
        'ExportToCSVOption' => [
            'AvailabilityStatus' => 'ENABLED|DISABLED',
        ],
        'SheetControlsOption' => [
            'VisibilityState' => 'EXPANDED|COLLAPSED',
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'Parameters' => [
        'DateTimeParameters' => [
            [
                'Name' => '<string>', // REQUIRED
                'Values' => [<integer || string || DateTime>, ...], // REQUIRED
            ],
            // ...
        ],
        'DecimalParameters' => [
            [
                'Name' => '<string>', // REQUIRED
                'Values' => [<float>, ...], // REQUIRED
            ],
            // ...
        ],
        'IntegerParameters' => [
            [
                'Name' => '<string>', // REQUIRED
                'Values' => [<integer>, ...], // REQUIRED
            ],
            // ...
        ],
        'StringParameters' => [
            [
                'Name' => '<string>', // REQUIRED
                'Values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
    ],
    'Permissions' => [
        [
            'Actions' => ['<string>', ...], // REQUIRED
            'Principal' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'SourceEntity' => [ // REQUIRED
        'SourceTemplate' => [
            'Arn' => '<string>', // REQUIRED
            'DataSetReferences' => [ // REQUIRED
                [
                    'DataSetArn' => '<string>', // REQUIRED
                    'DataSetPlaceholder' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ThemeArn' => '<string>',
    'VersionDescription' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
    'DashboardId' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
    'VersionArn' => '<string>',
]

Result Details

Errors

• ResourceNotFoundException:

  One or more resources can't be found.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ThrottlingException:

  Access is throttled.

• ResourceExistsException:

  The resource specified already exists.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• InternalFailureException:

  An internal failure occurred.

CreateDataSet

$result = $client->createDataSet([/* ... */]);
$promise = $client->createDataSetAsync([/* ... */]);

Parameter Syntax

$result = $client->createDataSet([
    'AwsAccountId' => '<string>', // REQUIRED
    'ColumnGroups' => [
        [
            'GeoSpatialColumnGroup' => [
                'Columns' => ['<string>', ...], // REQUIRED
                'CountryCode' => 'US', // REQUIRED
                'Name' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
    'DataSetId' => '<string>', // REQUIRED
    'ImportMode' => 'SPICE|DIRECT_QUERY', // REQUIRED
    'LogicalTableMap' => [
        '<LogicalTableId>' => [
            'Alias' => '<string>', // REQUIRED
            'DataTransforms' => [
                [
                    'CastColumnTypeOperation' => [
                        'ColumnName' => '<string>', // REQUIRED
                        'Format' => '<string>',
                        'NewColumnType' => 'STRING|INTEGER|DECIMAL|DATETIME', // REQUIRED
                    ],
                    'CreateColumnsOperation' => [
                        'Columns' => [ // REQUIRED
                            [
                                'ColumnId' => '<string>', // REQUIRED
                                'ColumnName' => '<string>', // REQUIRED
                                'Expression' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'FilterOperation' => [
                        'ConditionExpression' => '<string>', // REQUIRED
                    ],
                    'ProjectOperation' => [
                        'ProjectedColumns' => ['<string>', ...], // REQUIRED
                    ],
                    'RenameColumnOperation' => [
                        'ColumnName' => '<string>', // REQUIRED
                        'NewColumnName' => '<string>', // REQUIRED
                    ],
                    'TagColumnOperation' => [
                        'ColumnName' => '<string>', // REQUIRED
                        'Tags' => [ // REQUIRED
                            [
                                'ColumnGeographicRole' => 'COUNTRY|STATE|COUNTY|CITY|POSTCODE|LONGITUDE|LATITUDE',
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
            'Source' => [ // REQUIRED
                'JoinInstruction' => [
                    'LeftOperand' => '<string>', // REQUIRED
                    'OnClause' => '<string>', // REQUIRED
                    'RightOperand' => '<string>', // REQUIRED
                    'Type' => 'INNER|OUTER|LEFT|RIGHT', // REQUIRED
                ],
                'PhysicalTableId' => '<string>',
            ],
        ],
        // ...
    ],
    'Name' => '<string>', // REQUIRED
    'Permissions' => [
        [
            'Actions' => ['<string>', ...], // REQUIRED
            'Principal' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'PhysicalTableMap' => [ // REQUIRED
        '<PhysicalTableId>' => [
            'CustomSql' => [
                'Columns' => [
                    [
                        'Name' => '<string>', // REQUIRED
                        'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
                    ],
                    // ...
                ],
                'DataSourceArn' => '<string>', // REQUIRED
                'Name' => '<string>', // REQUIRED
                'SqlQuery' => '<string>', // REQUIRED
            ],
            'RelationalTable' => [
                'DataSourceArn' => '<string>', // REQUIRED
                'InputColumns' => [ // REQUIRED
                    [
                        'Name' => '<string>', // REQUIRED
                        'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
                    ],
                    // ...
                ],
                'Name' => '<string>', // REQUIRED
                'Schema' => '<string>',
            ],
            'S3Source' => [
                'DataSourceArn' => '<string>', // REQUIRED
                'InputColumns' => [ // REQUIRED
                    [
                        'Name' => '<string>', // REQUIRED
                        'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
                    ],
                    // ...
                ],
                'UploadSettings' => [
                    'ContainsHeader' => true || false,
                    'Delimiter' => '<string>',
                    'Format' => 'CSV|TSV|CLF|ELF|XLSX|JSON',
                    'StartFromRow' => <integer>,
                    'TextQualifier' => 'DOUBLE_QUOTE|SINGLE_QUOTE',
                ],
            ],
        ],
        // ...
    ],
    'RowLevelPermissionDataSet' => [
        'Arn' => '<string>', // REQUIRED
        'Namespace' => '<string>',
        'PermissionPolicy' => 'GRANT_ACCESS|DENY_ACCESS', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'DataSetId' => '<string>',
    'IngestionArn' => '<string>',
    'IngestionId' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• LimitExceededException:

  A limit is exceeded.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• InternalFailureException:

  An internal failure occurred.

CreateDataSource

$result = $client->createDataSource([/* ... */]);
$promise = $client->createDataSourceAsync([/* ... */]);

Parameter Syntax

$result = $client->createDataSource([
    'AwsAccountId' => '<string>', // REQUIRED
    'Credentials' => [
        'CopySourceArn' => '<string>',
        'CredentialPair' => [
            'AlternateDataSourceParameters' => [
                [
                    'AmazonElasticsearchParameters' => [
                        'Domain' => '<string>', // REQUIRED
                    ],
                    'AthenaParameters' => [
                        'WorkGroup' => '<string>',
                    ],
                    'AuroraParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'AuroraPostgreSqlParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'AwsIotAnalyticsParameters' => [
                        'DataSetName' => '<string>', // REQUIRED
                    ],
                    'JiraParameters' => [
                        'SiteBaseUrl' => '<string>', // REQUIRED
                    ],
                    'MariaDbParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'MySqlParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'PostgreSqlParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'PrestoParameters' => [
                        'Catalog' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'RdsParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'InstanceId' => '<string>', // REQUIRED
                    ],
                    'RedshiftParameters' => [
                        'ClusterId' => '<string>',
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>',
                        'Port' => <integer>,
                    ],
                    'S3Parameters' => [
                        'ManifestFileLocation' => [ // REQUIRED
                            'Bucket' => '<string>', // REQUIRED
                            'Key' => '<string>', // REQUIRED
                        ],
                    ],
                    'ServiceNowParameters' => [
                        'SiteBaseUrl' => '<string>', // REQUIRED
                    ],
                    'SnowflakeParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Warehouse' => '<string>', // REQUIRED
                    ],
                    'SparkParameters' => [
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'SqlServerParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'TeradataParameters' => [
                        'Database' => '<string>', // REQUIRED
                        'Host' => '<string>', // REQUIRED
                        'Port' => <integer>, // REQUIRED
                    ],
                    'TwitterParameters' => [
                        'MaxRows' => <integer>, // REQUIRED
                        'Query' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
            'Password' => '<string>', // REQUIRED
            'Username' => '<string>', // REQUIRED
        ],
    ],
    'DataSourceId' => '<string>', // REQUIRED
    'DataSourceParameters' => [
        'AmazonElasticsearchParameters' => [
            'Domain' => '<string>', // REQUIRED
        ],
        'AthenaParameters' => [
            'WorkGroup' => '<string>',
        ],
        'AuroraParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'AuroraPostgreSqlParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'AwsIotAnalyticsParameters' => [
            'DataSetName' => '<string>', // REQUIRED
        ],
        'JiraParameters' => [
            'SiteBaseUrl' => '<string>', // REQUIRED
        ],
        'MariaDbParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'MySqlParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'PostgreSqlParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'PrestoParameters' => [
            'Catalog' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'RdsParameters' => [
            'Database' => '<string>', // REQUIRED
            'InstanceId' => '<string>', // REQUIRED
        ],
        'RedshiftParameters' => [
            'ClusterId' => '<string>',
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>',
            'Port' => <integer>,
        ],
        'S3Parameters' => [
            'ManifestFileLocation' => [ // REQUIRED
                'Bucket' => '<string>', // REQUIRED
                'Key' => '<string>', // REQUIRED
            ],
        ],
        'ServiceNowParameters' => [
            'SiteBaseUrl' => '<string>', // REQUIRED
        ],
        'SnowflakeParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Warehouse' => '<string>', // REQUIRED
        ],
        'SparkParameters' => [
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'SqlServerParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'TeradataParameters' => [
            'Database' => '<string>', // REQUIRED
            'Host' => '<string>', // REQUIRED
            'Port' => <integer>, // REQUIRED
        ],
        'TwitterParameters' => [
            'MaxRows' => <integer>, // REQUIRED
            'Query' => '<string>', // REQUIRED
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'Permissions' => [
        [
            'Actions' => ['<string>', ...], // REQUIRED
            'Principal' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'SslProperties' => [
        'DisableSsl' => true || false,
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Type' => 'ADOBE_ANALYTICS|AMAZON_ELASTICSEARCH|ATHENA|AURORA|AURORA_POSTGRESQL|AWS_IOT_ANALYTICS|GITHUB|JIRA|MARIADB|MYSQL|POSTGRESQL|PRESTO|REDSHIFT|S3|SALESFORCE|SERVICENOW|SNOWFLAKE|SPARK|SQLSERVER|TERADATA|TWITTER', // REQUIRED
    'VpcConnectionProperties' => [
        'VpcConnectionArn' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
    'DataSourceId' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• LimitExceededException:

  A limit is exceeded.

• ResourceNotFoundException:

  One or more resources can't be found.

• ResourceExistsException:

  The resource specified already exists.

• ThrottlingException:

  Access is throttled.

• InternalFailureException:

  An internal failure occurred.

CreateGroup

$result = $client->createGroup([/* ... */]);
$promise = $client->createGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createGroup([
    'AwsAccountId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'GroupName' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Group' => [
        'Arn' => '<string>',
        'Description' => '<string>',
        'GroupName' => '<string>',
        'PrincipalId' => '<string>',
    ],
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• LimitExceededException:

  A limit is exceeded.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

CreateGroupMembership

$result = $client->createGroupMembership([/* ... */]);
$promise = $client->createGroupMembershipAsync([/* ... */]);

Parameter Syntax

$result = $client->createGroupMembership([
    'AwsAccountId' => '<string>', // REQUIRED
    'GroupName' => '<string>', // REQUIRED
    'MemberName' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GroupMember' => [
        'Arn' => '<string>',
        'MemberName' => '<string>',
    ],
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

CreateIAMPolicyAssignment

$result = $client->createIAMPolicyAssignment([/* ... */]);
$promise = $client->createIAMPolicyAssignmentAsync([/* ... */]);

Parameter Syntax

$result = $client->createIAMPolicyAssignment([
    'AssignmentName' => '<string>', // REQUIRED
    'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED', // REQUIRED
    'AwsAccountId' => '<string>', // REQUIRED
    'Identities' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'Namespace' => '<string>', // REQUIRED
    'PolicyArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AssignmentId' => '<string>',
    'AssignmentName' => '<string>',
    'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED',
    'Identities' => [
        '<String>' => ['<string>', ...],
        // ...
    ],
    'PolicyArn' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• ConcurrentUpdatingException:

  A resource is already in a state that indicates an action is happening that must complete before a new update can be applied.

• InternalFailureException:

  An internal failure occurred.

CreateIngestion

$result = $client->createIngestion([/* ... */]);
$promise = $client->createIngestionAsync([/* ... */]);

Parameter Syntax

$result = $client->createIngestion([
    'AwsAccountId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'IngestionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'IngestionId' => '<string>',
    'IngestionStatus' => 'INITIALIZED|QUEUED|RUNNING|FAILED|COMPLETED|CANCELLED',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• LimitExceededException:

  A limit is exceeded.

• ResourceExistsException:

  The resource specified already exists.

• InternalFailureException:

  An internal failure occurred.

CreateNamespace

$result = $client->createNamespace([/* ... */]);
$promise = $client->createNamespaceAsync([/* ... */]);

Parameter Syntax

$result = $client->createNamespace([
    'AwsAccountId' => '<string>', // REQUIRED
    'IdentityStore' => 'QUICKSIGHT', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CapacityRegion' => '<string>',
    'CreationStatus' => 'CREATED|CREATING|DELETING|RETRYABLE_FAILURE|NON_RETRYABLE_FAILURE',
    'IdentityStore' => 'QUICKSIGHT',
    'Name' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• LimitExceededException:

  A limit is exceeded.

• ResourceExistsException:

  The resource specified already exists.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

CreateTemplate

$result = $client->createTemplate([/* ... */]);
$promise = $client->createTemplateAsync([/* ... */]);

Parameter Syntax

$result = $client->createTemplate([
    'AwsAccountId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'Permissions' => [
        [
            'Actions' => ['<string>', ...], // REQUIRED
            'Principal' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'SourceEntity' => [ // REQUIRED
        'SourceAnalysis' => [
            'Arn' => '<string>', // REQUIRED
            'DataSetReferences' => [ // REQUIRED
                [
                    'DataSetArn' => '<string>', // REQUIRED
                    'DataSetPlaceholder' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'SourceTemplate' => [
            'Arn' => '<string>', // REQUIRED
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TemplateId' => '<string>', // REQUIRED
    'VersionDescription' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
    'RequestId' => '<string>',
    'Status' => <integer>,
    'TemplateId' => '<string>',
    'VersionArn' => '<string>',
]

Result Details

Errors

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• LimitExceededException:

  A limit is exceeded.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InternalFailureException:

  An internal failure occurred.

CreateTemplateAlias

$result = $client->createTemplateAlias([/* ... */]);
$promise = $client->createTemplateAliasAsync([/* ... */]);

Parameter Syntax

$result = $client->createTemplateAlias([
    'AliasName' => '<string>', // REQUIRED
    'AwsAccountId' => '<string>', // REQUIRED
    'TemplateId' => '<string>', // REQUIRED
    'TemplateVersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
    'TemplateAlias' => [
        'AliasName' => '<string>',
        'Arn' => '<string>',
        'TemplateVersionNumber' => <integer>,
    ],
]

Result Details

Errors

• ThrottlingException:

  Access is throttled.

• ResourceNotFoundException:

  One or more resources can't be found.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• ResourceExistsException:

  The resource specified already exists.

• LimitExceededException:

  A limit is exceeded.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InternalFailureException:

  An internal failure occurred.

CreateTheme

$result = $client->createTheme([/* ... */]);
$promise = $client->createThemeAsync([/* ... */]);

Parameter Syntax

$result = $client->createTheme([
    'AwsAccountId' => '<string>', // REQUIRED
    'BaseThemeId' => '<string>', // REQUIRED
    'Configuration' => [ // REQUIRED
        'DataColorPalette' => [
            'Colors' => ['<string>', ...],
            'EmptyFillColor' => '<string>',
            'MinMaxGradient' => ['<string>', ...],
        ],
        'Sheet' => [
            'Tile' => [
                'Border' => [
                    'Show' => true || false,
                ],
            ],
            'TileLayout' => [
                'Gutter' => [
                    'Show' => true || false,
                ],
                'Margin' => [
                    'Show' => true || false,
                ],
            ],
        ],
        'UIColorPalette' => [
            'Accent' => '<string>',
            'AccentForeground' => '<string>',
            'Danger' => '<string>',
            'DangerForeground' => '<string>',
            'Dimension' => '<string>',
            'DimensionForeground' => '<string>',
            'Measure' => '<string>',
            'MeasureForeground' => '<string>',
            'PrimaryBackground' => '<string>',
            'PrimaryForeground' => '<string>',
            'SecondaryBackground' => '<string>',
            'SecondaryForeground' => '<string>',
            'Success' => '<string>',
            'SuccessForeground' => '<string>',
            'Warning' => '<string>',
            'WarningForeground' => '<string>',
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'Permissions' => [
        [
            'Actions' => ['<string>', ...], // REQUIRED
            'Principal' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'ThemeId' => '<string>', // REQUIRED
    'VersionDescription' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
    'RequestId' => '<string>',
    'Status' => <integer>,
    'ThemeId' => '<string>',
    'VersionArn' => '<string>',
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• LimitExceededException:

  A limit is exceeded.

• InternalFailureException:

  An internal failure occurred.

CreateThemeAlias

$result = $client->createThemeAlias([/* ... */]);
$promise = $client->createThemeAliasAsync([/* ... */]);

Parameter Syntax

$result = $client->createThemeAlias([
    'AliasName' => '<string>', // REQUIRED
    'AwsAccountId' => '<string>', // REQUIRED
    'ThemeId' => '<string>', // REQUIRED
    'ThemeVersionNumber' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
    'ThemeAlias' => [
        'AliasName' => '<string>',
        'Arn' => '<string>',
        'ThemeVersionNumber' => <integer>,
    ],
]

Result Details

Errors

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• LimitExceededException:

  A limit is exceeded.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• InternalFailureException:

  An internal failure occurred.

DeleteAccountCustomization

$result = $client->deleteAccountCustomization([/* ... */]);
$promise = $client->deleteAccountCustomizationAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteAccountCustomization([
    'AwsAccountId' => '<string>', // REQUIRED
    'Namespace' => '<string>',
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DeleteDashboard

$result = $client->deleteDashboard([/* ... */]);
$promise = $client->deleteDashboardAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDashboard([
    'AwsAccountId' => '<string>', // REQUIRED
    'DashboardId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'DashboardId' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• ThrottlingException:

  Access is throttled.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• ResourceNotFoundException:

  One or more resources can't be found.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• InternalFailureException:

  An internal failure occurred.

DeleteDataSet

$result = $client->deleteDataSet([/* ... */]);
$promise = $client->deleteDataSetAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDataSet([
    'AwsAccountId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'DataSetId' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ThrottlingException:

  Access is throttled.

• ResourceNotFoundException:

  One or more resources can't be found.

• InternalFailureException:

  An internal failure occurred.

DeleteDataSource

$result = $client->deleteDataSource([/* ... */]);
$promise = $client->deleteDataSourceAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteDataSource([
    'AwsAccountId' => '<string>', // REQUIRED
    'DataSourceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'DataSourceId' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ThrottlingException:

  Access is throttled.

• ResourceNotFoundException:

  One or more resources can't be found.

• InternalFailureException:

  An internal failure occurred.

DeleteGroup

$result = $client->deleteGroup([/* ... */]);
$promise = $client->deleteGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteGroup([
    'AwsAccountId' => '<string>', // REQUIRED
    'GroupName' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DeleteGroupMembership

$result = $client->deleteGroupMembership([/* ... */]);
$promise = $client->deleteGroupMembershipAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteGroupMembership([
    'AwsAccountId' => '<string>', // REQUIRED
    'GroupName' => '<string>', // REQUIRED
    'MemberName' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DeleteIAMPolicyAssignment

$result = $client->deleteIAMPolicyAssignment([/* ... */]);
$promise = $client->deleteIAMPolicyAssignmentAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteIAMPolicyAssignment([
    'AssignmentName' => '<string>', // REQUIRED
    'AwsAccountId' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AssignmentName' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceExistsException:

  The resource specified already exists.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• ConcurrentUpdatingException:

  A resource is already in a state that indicates an action is happening that must complete before a new update can be applied.

• InternalFailureException:

  An internal failure occurred.

DeleteNamespace

$result = $client->deleteNamespace([/* ... */]);
$promise = $client->deleteNamespaceAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteNamespace([
    'AwsAccountId' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DeleteTemplate

$result = $client->deleteTemplate([/* ... */]);
$promise = $client->deleteTemplateAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteTemplate([
    'AwsAccountId' => '<string>', // REQUIRED
    'TemplateId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
    'TemplateId' => '<string>',
]

Result Details

Errors

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• LimitExceededException:

  A limit is exceeded.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• InternalFailureException:

  An internal failure occurred.

DeleteTemplateAlias

$result = $client->deleteTemplateAlias([/* ... */]);
$promise = $client->deleteTemplateAliasAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteTemplateAlias([
    'AliasName' => '<string>', // REQUIRED
    'AwsAccountId' => '<string>', // REQUIRED
    'TemplateId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AliasName' => '<string>',
    'Arn' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
    'TemplateId' => '<string>',
]

Result Details

Errors

• ThrottlingException:

  Access is throttled.

• ResourceNotFoundException:

  One or more resources can't be found.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InternalFailureException:

  An internal failure occurred.

DeleteTheme

$result = $client->deleteTheme([/* ... */]);
$promise = $client->deleteThemeAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteTheme([
    'AwsAccountId' => '<string>', // REQUIRED
    'ThemeId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>,
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
    'ThemeId' => '<string>',
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• InternalFailureException:

  An internal failure occurred.

DeleteThemeAlias

$result = $client->deleteThemeAlias([/* ... */]);
$promise = $client->deleteThemeAliasAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteThemeAlias([
    'AliasName' => '<string>', // REQUIRED
    'AwsAccountId' => '<string>', // REQUIRED
    'ThemeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AliasName' => '<string>',
    'Arn' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
    'ThemeId' => '<string>',
]

Result Details

Errors

• ConflictException:

  Updating or deleting a resource can cause an inconsistent state.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• UnsupportedUserEditionException:

  This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

• InternalFailureException:

  An internal failure occurred.

DeleteUser

$result = $client->deleteUser([/* ... */]);
$promise = $client->deleteUserAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteUser([
    'AwsAccountId' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
    'UserName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DeleteUserByPrincipalId

$result = $client->deleteUserByPrincipalId([/* ... */]);
$promise = $client->deleteUserByPrincipalIdAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteUserByPrincipalId([
    'AwsAccountId' => '<string>', // REQUIRED
    'Namespace' => '<string>', // REQUIRED
    'PrincipalId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• PreconditionNotMetException:

  One or more preconditions aren't met.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DescribeAccountCustomization

$result = $client->describeAccountCustomization([/* ... */]);
$promise = $client->describeAccountCustomizationAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAccountCustomization([
    'AwsAccountId' => '<string>', // REQUIRED
    'Namespace' => '<string>',
    'Resolved' => true || false,
]);

Parameter Details

Result Syntax

[
    'AccountCustomization' => [
        'DefaultTheme' => '<string>',
    ],
    'AwsAccountId' => '<string>',
    'Namespace' => '<string>',
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DescribeAccountSettings

$result = $client->describeAccountSettings([/* ... */]);
$promise = $client->describeAccountSettingsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAccountSettings([
    'AwsAccountId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AccountSettings' => [
        'AccountName' => '<string>',
        'DefaultNamespace' => '<string>',
        'Edition' => 'STANDARD|ENTERPRISE',
        'NotificationEmail' => '<string>',
    ],
    'RequestId' => '<string>',
    'Status' => <integer>,
]

Result Details

Errors

• AccessDeniedException:

  You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

• InvalidParameterValueException:

  One or more parameters has a value that isn't valid.

• ResourceNotFoundException:

  One or more resources can't be found.

• ThrottlingException:

  Access is throttled.

• InternalFailureException:

  An internal failure occurred.

• ResourceUnavailableException:

  This resource is currently unavailable.

DescribeDashboard

$result = $client->describeDashboard([/* ... */]);
$promise = $client->describeDashboardAsync([/* ... */]);

Parameter Syntax

$result = $client->describeDashboard([
    'AliasName' => '<string>',
    'AwsAccountId' => '<string>', // REQUIRED
    'DashboardId' => '<string>', // REQUIRED
    'VersionNumber' => <integer>,
]);

Parameter Details