Amazon QuickSight

2026/06/01 - Amazon QuickSight - 22 new api methods

Changes  This release adds public APIs for Amazon QuickSight Spaces, Agents, and Flows. Spaces APIs enable management of curated resource collections. Agents APIs provide lifecycle control over AI-powered agents that leverage Spaces. Flows APIs add CRUDL APIs for automated workflows.

ListAgents (new) Link ¶

Lists all agents in an Amazon QuickSight account.

See also: AWS API Documentation

Request Syntax

client.list_agents(
    AwsAccountId='string',
    MaxResults=123,
    NextToken='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agents.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

The token for the next set of results, or null if there are no more results.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string',
    'AgentSummaries': [
        {
            'Arn': 'string',
            'AgentId': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'IconId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • AgentSummaries (list) --

      A list of agent summaries.

      • (dict) --

        A summary of an agent, including its identifier, name, and metadata.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the agent.

        • AgentId (string) --

          The unique identifier for the agent.

        • Name (string) --

          The name of the agent.

        • Description (string) --

          A description of the agent.

        • CreatedAt (datetime) --

          The date and time that the agent was created.

        • UpdatedAt (datetime) --

          The date and time that the agent was last updated.

        • IconId (string) --

          The icon identifier for the agent.

    • NextToken (string) --

      The token for the next set of results, or null if there are no more results.

UpdateSpace (new) Link ¶

Updates the metadata of an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

client.update_space(
    AwsAccountId='string',
    SpaceId='string',
    Name='string',
    Description='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space that you want to update.

type Name:

string

param Name:

A new display name for the space.

type Description:

string

param Description:

A new description for the space.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

DescribeSpacePermissions (new) Link ¶

Describes the permissions for an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

client.describe_space_permissions(
    AwsAccountId='string',
    SpaceId='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space that you want to describe permissions for.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • Permissions (list) --

      A list of resource permissions for the space.

      • (dict) --

        Permission for the resource.

        • Principal (string) --

          The Amazon Resource Name (ARN) of the principal. This can be one of the following:

          • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

          • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

          • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

        • Actions (list) --

          The IAM action to grant or revoke permissions on.

          • (string) --

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

DeleteSpace (new) Link ¶

Deletes an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

client.delete_space(
    AwsAccountId='string',
    SpaceId='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space that you want to delete.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

DeleteAgent (new) Link ¶

Deletes an agent.

See also: AWS API Documentation

Request Syntax

client.delete_agent(
    AgentId='string',
    AwsAccountId='string'
)
type AgentId:

string

param AgentId:

[REQUIRED]

The unique identifier for the agent to delete.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agent.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

DeleteFlow (new) Link ¶

Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.

See also: AWS API Documentation

Request Syntax

client.delete_flow(
    AwsAccountId='string',
    FlowId='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the flow that you are deleting.

type FlowId:

string

param FlowId:

[REQUIRED]

The unique identifier of the flow to delete.

rtype:

dict

returns:

Response Syntax

{
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

DescribeAgent (new) Link ¶

Describes an agent.

See also: AWS API Documentation

Request Syntax

client.describe_agent(
    AgentId='string',
    AwsAccountId='string'
)
type AgentId:

string

param AgentId:

[REQUIRED]

The unique identifier for the agent.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agent.

rtype:

dict

returns:

Response Syntax

{
    'Agent': {
        'Spaces': [
            'string',
        ],
        'ActionConnectors': [
            'string',
        ],
        'Description': 'string',
        'IconId': 'string',
        'Name': 'string',
        'StarterPrompts': [
            'string',
        ],
        'WelcomeMessage': 'string',
        'Arn': 'string',
        'AgentId': 'string',
        'AgentLifecycle': 'PREVIEW'|'PUBLISHED',
        'AgentStatus': 'ACTIVE'|'UPDATING'|'FAILED'|'CREATING',
        'CreatedAt': datetime(2015, 1, 1),
        'Creator': 'string',
        'CustomPromptInterface': {
            'ModelProfileId': 'string',
            'SubscriptionId': 'string',
            'QbsAwsAccountId': 'string',
            'ResponseLength': 'string',
            'OutputStyle': 'string',
            'Identity': 'string',
            'Tone': 'string',
            'CustomInstructions': 'string',
            'promptSummary': 'string'
        },
        'ErrorMessage': 'string',
        'UpdatedAt': datetime(2015, 1, 1)
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Agent (dict) --

      The full details of the agent, including its configuration, status, and associations.

      • Spaces (list) --

        The Amazon Resource Names (ARNs) of the spaces attached to the agent.

        • (string) --

      • ActionConnectors (list) --

        The Amazon Resource Names (ARNs) of the action connectors attached to the agent.

        • (string) --

      • Description (string) --

        A description of the agent.

      • IconId (string) --

        The icon identifier for the agent.

      • Name (string) --

        The name of the agent.

      • StarterPrompts (list) --

        A list of starter prompts that are displayed to users when they begin interacting with the agent.

        • (string) --

      • WelcomeMessage (string) --

        The welcome message that is displayed when a user starts a conversation with the agent.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the agent.

      • AgentId (string) --

        The unique identifier for the agent.

      • AgentLifecycle (string) --

        The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

      • AgentStatus (string) --

        The status of the agent.

      • CreatedAt (datetime) --

        The date and time that the agent was created.

      • Creator (string) --

        The identity of the user who created the agent.

      • CustomPromptInterface (dict) --

        The custom prompt interface configuration for the agent.

        • ModelProfileId (string) --

          The identifier of the model profile.

        • SubscriptionId (string) --

          The subscription identifier.

        • QbsAwsAccountId (string) --

          The Amazon Web Services account ID for the Q Business service.

        • ResponseLength (string) --

          Instructions for the desired response length.

        • OutputStyle (string) --

          Instructions for the desired output style.

        • Identity (string) --

          Instructions that define the agent's identity and persona.

        • Tone (string) --

          Instructions for the desired tone of responses.

        • CustomInstructions (string) --

          Custom instructions for the agent's behavior.

        • promptSummary (string) --

          A summary of the custom prompt configuration.

      • ErrorMessage (string) --

        An error message associated with the agent, if applicable.

      • UpdatedAt (datetime) --

        The date and time that the agent was last updated.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

SearchAgents (new) Link ¶

Searches for agents based on specified filters.

See also: AWS API Documentation

Request Syntax

client.search_agents(
    AwsAccountId='string',
    Filters=[
        {
            'Name': 'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'AGENT_NAME',
            'Operator': 'StringEquals'|'StringLike',
            'Value': 'string'
        },
    ],
    MaxResults=123,
    NextToken='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agents.

type Filters:

list

param Filters:

[REQUIRED]

The filters to apply when searching agents.

  • (dict) --

    A filter to apply when searching agents.

    • Name (string) --

      The name of the field to filter on.

    • Operator (string) --

      The comparison operator to use for the filter.

    • Value (string) --

      The value to filter on.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type NextToken:

string

param NextToken:

The token for the next set of results, or null if there are no more results.

rtype:

dict

returns:

Response Syntax

{
    'AgentSummaries': [
        {
            'Arn': 'string',
            'AgentId': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'IconId': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • AgentSummaries (list) --

      A list of agent summaries.

      • (dict) --

        A summary of an agent, including its identifier, name, and metadata.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the agent.

        • AgentId (string) --

          The unique identifier for the agent.

        • Name (string) --

          The name of the agent.

        • Description (string) --

          A description of the agent.

        • CreatedAt (datetime) --

          The date and time that the agent was created.

        • UpdatedAt (datetime) --

          The date and time that the agent was last updated.

        • IconId (string) --

          The icon identifier for the agent.

    • NextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

UpdateAgent (new) Link ¶

Updates an existing agent.

See also: AWS API Documentation

Request Syntax

client.update_agent(
    AgentId='string',
    AwsAccountId='string',
    Name='string',
    Description='string',
    IconId='string',
    StarterPrompts=[
        'string',
    ],
    WelcomeMessage='string',
    CustomPromptInput={
        'ExistingPrompt': {
            'ModelProfileId': 'string',
            'SubscriptionId': 'string',
            'QbsAwsAccountId': 'string'
        },
        'NewPrompt': {
            'ResponseLength': 'string',
            'OutputStyle': 'string',
            'Identity': 'string',
            'Tone': 'string',
            'CustomInstructions': 'string'
        }
    },
    SpacesToAdd=[
        'string',
    ],
    SpacesToRemove=[
        'string',
    ],
    ActionConnectorsToAdd=[
        'string',
    ],
    ActionConnectorsToRemove=[
        'string',
    ]
)
type AgentId:

string

param AgentId:

[REQUIRED]

The unique identifier for the agent to update.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agent.

type Name:

string

param Name:

[REQUIRED]

The name of the agent.

type Description:

string

param Description:

A description of the agent.

type IconId:

string

param IconId:

The icon identifier for the agent.

type StarterPrompts:

list

param StarterPrompts:

A list of starter prompts that are displayed to users when they begin interacting with the agent.

  • (string) --

type WelcomeMessage:

string

param WelcomeMessage:

The welcome message that is displayed when a user starts a conversation with the agent.

type CustomPromptInput:

dict

param CustomPromptInput:

The custom prompt configuration for the agent.

  • ExistingPrompt (dict) --

    An existing custom prompt profile to use for the agent.

    • ModelProfileId (string) -- [REQUIRED]

      The identifier of the model profile.

    • SubscriptionId (string) -- [REQUIRED]

      The subscription identifier.

    • QbsAwsAccountId (string) -- [REQUIRED]

      The Amazon Web Services account ID for the Q Business service.

  • NewPrompt (dict) --

    New custom prompt parameters to configure for the agent.

    • ResponseLength (string) --

      Instructions for the desired response length.

    • OutputStyle (string) --

      Instructions for the desired output style.

    • Identity (string) --

      Instructions that define the agent's identity and persona.

    • Tone (string) --

      Instructions for the desired tone of responses.

    • CustomInstructions (string) --

      Custom instructions for the agent's behavior.

type SpacesToAdd:

list

param SpacesToAdd:

The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

  • (string) --

type SpacesToRemove:

list

param SpacesToRemove:

The Amazon Resource Names (ARNs) of the spaces to detach from the agent.

  • (string) --

type ActionConnectorsToAdd:

list

param ActionConnectorsToAdd:

The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

  • (string) --

type ActionConnectorsToRemove:

list

param ActionConnectorsToRemove:

The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'AgentId': 'string',
    'AgentStatus': 'ACTIVE'|'UPDATING'|'FAILED'|'CREATING',
    'FailedToAddSpaces': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'FailedToRemoveSpaces': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'FailedToAddActionConnectors': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'FailedToRemoveActionConnectors': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the agent.

    • AgentId (string) --

      The unique identifier for the agent.

    • AgentStatus (string) --

      The status of the agent.

    • FailedToAddSpaces (list) --

      A list of per-ARN failures from the spaces that were requested to be added.

      • (dict) --

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) --

          The ARN that could not be added or removed.

        • ErrorMessage (string) --

          A description of the failure.

        • ErrorCode (string) --

          The error code for the failure.

    • FailedToRemoveSpaces (list) --

      A list of per-ARN failures from the spaces that were requested to be removed.

      • (dict) --

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) --

          The ARN that could not be added or removed.

        • ErrorMessage (string) --

          A description of the failure.

        • ErrorCode (string) --

          The error code for the failure.

    • FailedToAddActionConnectors (list) --

      A list of per-ARN failures from the action connectors that were requested to be added.

      • (dict) --

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) --

          The ARN that could not be added or removed.

        • ErrorMessage (string) --

          A description of the failure.

        • ErrorCode (string) --

          The error code for the failure.

    • FailedToRemoveActionConnectors (list) --

      A list of per-ARN failures from the action connectors that were requested to be removed.

      • (dict) --

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) --

          The ARN that could not be added or removed.

        • ErrorMessage (string) --

          A description of the failure.

        • ErrorCode (string) --

          The error code for the failure.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

UpdateSpacePermissions (new) Link ¶

Updates the permissions for an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

client.update_space_permissions(
    AwsAccountId='string',
    SpaceId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space that you want to update permissions for.

type GrantPermissions:

list

param GrantPermissions:

The permissions that you want to grant on the space.

  • (dict) --

    Permission for the resource.

    • Principal (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the principal. This can be one of the following:

      • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

      • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

      • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

    • Actions (list) -- [REQUIRED]

      The IAM action to grant or revoke permissions on.

      • (string) --

type RevokePermissions:

list

param RevokePermissions:

The permissions that you want to revoke from the space.

  • (dict) --

    Permission for the resource.

    • Principal (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the principal. This can be one of the following:

      • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

      • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

      • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

    • Actions (list) -- [REQUIRED]

      The IAM action to grant or revoke permissions on.

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'requestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • permissions (list) --

      The updated permissions for the space.

      • (dict) --

        Permission for the resource.

        • Principal (string) --

          The Amazon Resource Name (ARN) of the principal. This can be one of the following:

          • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

          • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

          • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

        • Actions (list) --

          The IAM action to grant or revoke permissions on.

          • (string) --

    • requestId (string) --

      The Amazon Web Services request ID for this operation.

UpdateSpaceResources (new) Link ¶

Adds or removes resources from an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

client.update_space_resources(
    AwsAccountId='string',
    SpaceId='string',
    AddResources=[
        {
            'ResourceType': 'TOPIC'|'DASHBOARD'|'KNOWLEDGE_BASE'|'SPACE'|'ACTION_CONNECTOR'|'DATA_SET'|'ARTIFACT',
            'ResourceDetails': {
                'resourceArn': 'string'
            }
        },
    ],
    RemoveResources=[
        {
            'ResourceType': 'TOPIC'|'DASHBOARD'|'KNOWLEDGE_BASE'|'SPACE'|'ACTION_CONNECTOR'|'DATA_SET'|'ARTIFACT',
            'ResourceDetails': {
                'resourceArn': 'string'
            }
        },
    ]
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space that you want to update resources for.

type AddResources:

list

param AddResources:

A list of resources to add to the space.

  • (dict) --

    An operation to perform on a resource in a space.

    • ResourceType (string) -- [REQUIRED]

      The type of the resource.

    • ResourceDetails (dict) -- [REQUIRED]

      The details of the resource.

      • resourceArn (string) --

        The ARN of the QuickSight resource.

type RemoveResources:

list

param RemoveResources:

A list of resources to remove from the space.

  • (dict) --

    An operation to perform on a resource in a space.

    • ResourceType (string) -- [REQUIRED]

      The type of the resource.

    • ResourceDetails (dict) -- [REQUIRED]

      The details of the resource.

      • resourceArn (string) --

        The ARN of the QuickSight resource.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'FailedResourceOperations': [
        {
            'ResourceType': 'TOPIC'|'DASHBOARD'|'KNOWLEDGE_BASE'|'SPACE'|'ACTION_CONNECTOR'|'DATA_SET'|'ARTIFACT',
            'ResourceDetails': {
                'resourceArn': 'string'
            },
            'ErrorMessage': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • FailedResourceOperations (list) --

      A list of resource operations that failed.

      • (dict) --

        A resource operation that failed.

        • ResourceType (string) --

          The type of the resource.

        • ResourceDetails (dict) --

          The details of the resource.

          • resourceArn (string) --

            The ARN of the QuickSight resource.

        • ErrorMessage (string) --

          The error message that describes why the operation failed.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

SearchSpaces (new) Link ¶

Searches for Amazon QuickSight spaces that match the specified filters.

See also: AWS API Documentation

Request Syntax

client.search_spaces(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'name': 'SPACE_ID'|'SPACE_NAME'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'CONTRIBUTED_BY'|'CONSUMED_SOURCE_SIZE'|'CREATED_BY',
            'operator': 'STRING_EQUALS'|'STRING_LIKE'|'NUMBER_RANGE',
            'value': 'string'
        },
    ]
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the spaces.

type NextToken:

string

param NextToken:

The token for the next set of results, or null if there are no more results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

type Filters:

list

param Filters:

[REQUIRED]

The filters to apply to the search.

  • (dict) --

    A filter to use when searching for spaces.

    • name (string) -- [REQUIRED]

      The name of the filter field to use.

    • operator (string) -- [REQUIRED]

      The comparison operator to use for the filter.

    • value (string) -- [REQUIRED]

      The value to use for the filter.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'SpaceSummaries': [
        {
            'spaceId': 'string',
            'spaceArn': 'string',
            'name': 'string',
            'description': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'consumedSourceSize': 123,
            'consumedSourceDocCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'createdByArn': 'string',
            'resourcesCount': 123
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • SpaceSummaries (list) --

      A list of space summaries that match the search criteria.

      • (dict) --

        A summary of an Amazon QuickSight space.

        • spaceId (string) --

          The ID of the space.

        • spaceArn (string) --

          The ARN of the space.

        • name (string) --

          The display name of the space.

        • description (string) --

          The description of the space.

        • updatedAt (datetime) --

          The date and time that the space was last updated.

        • consumedSourceSize (integer) --

          The total consumed source size in bytes.

        • consumedSourceDocCount (integer) --

          The number of consumed source documents.

        • createdAt (datetime) --

          The date and time that the space was created.

        • createdBy (string) --

          The user who created the space.

        • createdByArn (string) --

          The ARN of the user who created the space.

        • resourcesCount (integer) --

          The number of resources in the space.

    • NextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

UpdateAgentPermissions (new) Link ¶

Updates the resource permissions for an agent.

See also: AWS API Documentation

Request Syntax

client.update_agent_permissions(
    AgentId='string',
    AwsAccountId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)
type AgentId:

string

param AgentId:

[REQUIRED]

The unique identifier for the agent.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agent.

type GrantPermissions:

list

param GrantPermissions:

The resource permissions that you want to grant on the agent.

  • (dict) --

    Permission for the resource.

    • Principal (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the principal. This can be one of the following:

      • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

      • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

      • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

    • Actions (list) -- [REQUIRED]

      The IAM action to grant or revoke permissions on.

      • (string) --

type RevokePermissions:

list

param RevokePermissions:

The resource permissions that you want to revoke from the agent.

  • (dict) --

    Permission for the resource.

    • Principal (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the principal. This can be one of the following:

      • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

      • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

      • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

    • Actions (list) -- [REQUIRED]

      The IAM action to grant or revoke permissions on.

      • (string) --

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'AgentId': 'string',
    'RequestId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the agent.

    • AgentId (string) --

      The unique identifier for the agent.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Permissions (list) --

      The resource permissions for the agent.

      • (dict) --

        Permission for the resource.

        • Principal (string) --

          The Amazon Resource Name (ARN) of the principal. This can be one of the following:

          • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

          • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

          • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

        • Actions (list) --

          The IAM action to grant or revoke permissions on.

          • (string) --

DescribeAgentPermissions (new) Link ¶

Describes the resource permissions for an agent.

See also: AWS API Documentation

Request Syntax

client.describe_agent_permissions(
    AgentId='string',
    AwsAccountId='string'
)
type AgentId:

string

param AgentId:

[REQUIRED]

The unique identifier for the agent.

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agent.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'AgentId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the agent.

    • AgentId (string) --

      The unique identifier for the agent.

    • Permissions (list) --

      The resource permissions for the agent.

      • (dict) --

        Permission for the resource.

        • Principal (string) --

          The Amazon Resource Name (ARN) of the principal. This can be one of the following:

          • The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)

          • The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)

          • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)

        • Actions (list) --

          The IAM action to grant or revoke permissions on.

          • (string) --

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

DescribeFlow (new) Link ¶

Returns the full details of a flow for the latest version of the requested publish state.

See also: AWS API Documentation

Request Syntax

client.describe_flow(
    AwsAccountId='string',
    FlowId='string',
    PublishState='PUBLISHED'|'DRAFT'|'PENDING_APPROVAL'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the flow that you are describing.

type FlowId:

string

param FlowId:

[REQUIRED]

The unique identifier of the flow.

type PublishState:

string

param PublishState:

[REQUIRED]

The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

rtype:

dict

returns:

Response Syntax

{
    'Flow': {
        'Arn': 'string',
        'FlowId': 'string',
        'Name': 'string',
        'Description': 'string',
        'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
        'CreatedTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'LastUpdatedTime': datetime(2015, 1, 1),
        'LastUpdatedBy': 'string',
        'FlowDefinition': {...}|[...]|123|123.4|'string'|True|None,
        'StepAliases': [
            {
                'StepId': 'string',
                'StepAlias': 'string'
            },
        ]
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • Flow (dict) --

      The full details of the flow.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the flow.

      • FlowId (string) --

        The unique identifier of the flow.

      • Name (string) --

        The display name of the flow.

      • Description (string) --

        The description of the flow.

      • PublishState (string) --

        The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

      • CreatedTime (datetime) --

        The time this flow was created.

      • CreatedBy (string) --

        The identifier of the principal who created the flow.

      • LastUpdatedTime (datetime) --

        The last time this flow was modified.

      • LastUpdatedBy (string) --

        The identifier of the last principal who updated the flow.

      • FlowDefinition (:ref:`document<document>`) --

        The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

      • StepAliases (list) --

        A list of step alias mappings for the flow.

        • (dict) --

          A mapping between a step identifier and its alias in a flow.

          • StepId (string) --

            The unique identifier of the step.

          • StepAlias (string) --

            The alias for the step.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

DescribeSpace (new) Link ¶

Describes an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

client.describe_space(
    AwsAccountId='string',
    SpaceId='string',
    MaxContributors=123
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space that you want to describe.

type MaxContributors:

integer

param MaxContributors:

The maximum number of contributors to include in the response.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'Space': {
        'name': 'string',
        'description': 'string',
        'resources': [
            {
                'resourceType': 'TOPIC'|'DASHBOARD'|'KNOWLEDGE_BASE'|'SPACE'|'ACTION_CONNECTOR'|'DATA_SET'|'ARTIFACT',
                'resourceDetails': {
                    'resourceArn': 'string'
                }
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'consumedSourceSize': 123,
        'consumedSourceDocCount': 123,
        'createdBy': 'string',
        'createdByArn': 'string'
    },
    'Contributors': [
        {
            'userName': 'string',
            'rawFileSizeBytes': 123,
            'percentage': 123.0
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • Space (dict) --

      The details of the space.

      • name (string) --

        The display name of the space.

      • description (string) --

        The description of the space.

      • resources (list) --

        The resources in the space.

        • (dict) --

          A QuickSight resource that is associated with a space.

          • resourceType (string) --

            The type of the QuickSight resource.

          • resourceDetails (dict) --

            The details of the QuickSight resource.

            • resourceArn (string) --

              The ARN of the QuickSight resource.

      • createdAt (datetime) --

        The date and time that the space was created.

      • updatedAt (datetime) --

        The date and time that the space was last updated.

      • consumedSourceSize (integer) --

        The total consumed source size in bytes.

      • consumedSourceDocCount (integer) --

        The number of consumed source documents.

      • createdBy (string) --

        The user who created the space.

      • createdByArn (string) --

        The ARN of the user who created the space.

    • Contributors (list) --

      A list of contributors to the space.

      • (dict) --

        A contributor to an Amazon QuickSight space.

        • userName (string) --

          The user name of the contributor.

        • rawFileSizeBytes (integer) --

          The raw file size in bytes contributed by the user.

        • percentage (float) --

          The percentage of total contributions made by the user.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

UpdateFlow (new) Link ¶

Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.

See also: AWS API Documentation

Request Syntax

client.update_flow(
    AwsAccountId='string',
    FlowId='string',
    Name='string',
    Description='string',
    FlowDefinition={...}|[...]|123|123.4|'string'|True|None,
    ClientToken='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the flow that you are updating.

type FlowId:

string

param FlowId:

[REQUIRED]

The unique identifier of the flow to update.

type Name:

string

param Name:

Updated display name for the flow. Omit to preserve the existing name.

type Description:

string

param Description:

Updated description for the flow. Omit to preserve the existing description.

type FlowDefinition:

:ref:`document<document>`

param FlowDefinition:

The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change. When provided, all existing steps are replaced. Omit to preserve the existing definition.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'FlowId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the flow.

    • FlowId (string) --

      The unique identifier of the flow.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

ListSpaces (new) Link ¶

Lists all Amazon QuickSight spaces in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_spaces(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the spaces.

type NextToken:

string

param NextToken:

The token for the next set of results, or null if there are no more results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'SpaceSummaries': [
        {
            'spaceId': 'string',
            'spaceArn': 'string',
            'name': 'string',
            'description': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'consumedSourceSize': 123,
            'consumedSourceDocCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'createdByArn': 'string',
            'resourcesCount': 123
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • SpaceSummaries (list) --

      A list of space summaries.

      • (dict) --

        A summary of an Amazon QuickSight space.

        • spaceId (string) --

          The ID of the space.

        • spaceArn (string) --

          The ARN of the space.

        • name (string) --

          The display name of the space.

        • description (string) --

          The description of the space.

        • updatedAt (datetime) --

          The date and time that the space was last updated.

        • consumedSourceSize (integer) --

          The total consumed source size in bytes.

        • consumedSourceDocCount (integer) --

          The number of consumed source documents.

        • createdAt (datetime) --

          The date and time that the space was created.

        • createdBy (string) --

          The user who created the space.

        • createdByArn (string) --

          The ARN of the user who created the space.

        • resourcesCount (integer) --

          The number of resources in the space.

    • NextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

CreateSpace (new) Link ¶

Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.

See also: AWS API Documentation

Request Syntax

client.create_space(
    AwsAccountId='string',
    SpaceId='string',
    Name='string',
    Description='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

type Name:

string

param Name:

[REQUIRED]

A display name for the space.

type Description:

string

param Description:

A description of the space.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

CreateAgent (new) Link ¶

Creates an agent in Amazon QuickSight.

See also: AWS API Documentation

Request Syntax

client.create_agent(
    Spaces=[
        'string',
    ],
    ActionConnectors=[
        'string',
    ],
    AwsAccountId='string',
    AgentId='string',
    Name='string',
    Description='string',
    IconId='string',
    StarterPrompts=[
        'string',
    ],
    WelcomeMessage='string',
    AgentLifecycle='PREVIEW'|'PUBLISHED',
    CustomPromptInput={
        'ExistingPrompt': {
            'ModelProfileId': 'string',
            'SubscriptionId': 'string',
            'QbsAwsAccountId': 'string'
        },
        'NewPrompt': {
            'ResponseLength': 'string',
            'OutputStyle': 'string',
            'Identity': 'string',
            'Tone': 'string',
            'CustomInstructions': 'string'
        }
    }
)
type Spaces:

list

param Spaces:

The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

  • (string) --

type ActionConnectors:

list

param ActionConnectors:

The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

  • (string) --

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the agent.

type AgentId:

string

param AgentId:

[REQUIRED]

A unique identifier for the agent.

type Name:

string

param Name:

[REQUIRED]

The name of the agent.

type Description:

string

param Description:

A description of the agent.

type IconId:

string

param IconId:

The icon identifier for the agent.

type StarterPrompts:

list

param StarterPrompts:

A list of starter prompts that are displayed to users when they begin interacting with the agent.

  • (string) --

type WelcomeMessage:

string

param WelcomeMessage:

The welcome message that is displayed when a user starts a conversation with the agent.

type AgentLifecycle:

string

param AgentLifecycle:

The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED.

type CustomPromptInput:

dict

param CustomPromptInput:

The custom prompt configuration for the agent.

  • ExistingPrompt (dict) --

    An existing custom prompt profile to use for the agent.

    • ModelProfileId (string) -- [REQUIRED]

      The identifier of the model profile.

    • SubscriptionId (string) -- [REQUIRED]

      The subscription identifier.

    • QbsAwsAccountId (string) -- [REQUIRED]

      The Amazon Web Services account ID for the Q Business service.

  • NewPrompt (dict) --

    New custom prompt parameters to configure for the agent.

    • ResponseLength (string) --

      Instructions for the desired response length.

    • OutputStyle (string) --

      Instructions for the desired output style.

    • Identity (string) --

      Instructions that define the agent's identity and persona.

    • Tone (string) --

      Instructions for the desired tone of responses.

    • CustomInstructions (string) --

      Custom instructions for the agent's behavior.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'AgentId': 'string',
    'AgentStatus': 'ACTIVE'|'UPDATING'|'FAILED'|'CREATING',
    'AgentName': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the agent.

    • AgentId (string) --

      The unique identifier for the agent.

    • AgentStatus (string) --

      The status of the agent.

    • AgentName (string) --

      The name of the agent.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

CreateFlow (new) Link ¶

Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version.

This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources.

See also: AWS API Documentation

Request Syntax

client.create_flow(
    AwsAccountId='string',
    Name='string',
    Description='string',
    FlowDefinition={...}|[...]|123|123.4|'string'|True|None,
    Permissions=[
        {
            'Actions': [
                'string',
            ],
            'Principal': 'string'
        },
    ],
    ClientToken='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account where you want to create the flow.

type Name:

string

param Name:

[REQUIRED]

The display name for the flow.

type Description:

string

param Description:

The description for the flow.

type FlowDefinition:

:ref:`document<document>`

param FlowDefinition:

[REQUIRED]

The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

type Permissions:

list

param Permissions:

Initial permissions for the flow. If omitted, the flow is created without any permissions.

  • (dict) --

    A structure that contains the permission information for one principal against one flow.

    • Actions (list) -- [REQUIRED]

      A list of actions that the principal can perform against the flow.

      The following are the list of values to set a principal as a flow owner:

      • quicksight:PublishFlow

      • quicksight:GetFlow

      • quicksight:UpdateFlowPermissions

      • quicksight:GetFlowSession

      • quicksight:StartFlowSession

      • quicksight:StopFlowSession

      • quicksight:UpdateFlowSession

      • quicksight:UnpublishFlow

      • quicksight:GetFlowStages

      • quicksight:DeleteFlow

      • quicksight:DescribeFlowPermissions

      • quicksight:UpdateFlow

      • quicksight:CreatePresignedUrl

      The following are the list of values to set a principal as a flow viewer:

      • quicksight:GetFlow

      • quicksight:UpdateFlowSession

      • quicksight:StartFlowSession

      • quicksight:StopFlowSession

      • quicksight:GetFlowSession

      • quicksight:CreatePresignedUrl

      • quicksight:GetFlowStages

      • (string) --

    • Principal (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the principal. This can be an Amazon Quick user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.

type ClientToken:

string

param ClientToken:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'FlowId': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the flow.

    • FlowId (string) --

      The unique identifier of the flow.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

ListSpaceResources (new) Link ¶

Lists the resources in an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

client.list_space_resources(
    AwsAccountId='string',
    SpaceId='string'
)
type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

The ID of the Amazon Web Services account that contains the space.

type SpaceId:

string

param SpaceId:

[REQUIRED]

The ID of the space that you want to list resources for.

rtype:

dict

returns:

Response Syntax

{
    'spaceId': 'string',
    'spaceArn': 'string',
    'SpaceResources': [
        {
            'ResourceType': 'TOPIC'|'DASHBOARD'|'KNOWLEDGE_BASE'|'SPACE'|'ACTION_CONNECTOR'|'DATA_SET'|'ARTIFACT',
            'ResourceDetails': {
                'resourceArn': 'string'
            },
            'ResourceName': 'string',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • spaceId (string) --

      The ID of the space.

    • spaceArn (string) --

      The ARN of the space.

    • SpaceResources (list) --

      A list of resource summaries in the space.

      • (dict) --

        A summary of a resource in a space.

        • ResourceType (string) --

          The type of the resource.

        • ResourceDetails (dict) --

          The details of the resource.

          • resourceArn (string) --

            The ARN of the QuickSight resource.

        • ResourceName (string) --

          The name of the resource.

        • UpdatedAt (datetime) --

          The date and time that the resource was last updated.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.