QuickSight / Client / update_space_resources

update_space_resources

QuickSight.Client.update_space_resources(**kwargs)

Adds or removes resources from an Amazon QuickSight space.

See also: AWS API Documentation

Request Syntax

response = 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'
            }
        },
    ]
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

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

  • SpaceId (string) –

    [REQUIRED]

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

  • AddResources (list) –

    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.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceArn.

        • resourceArn (string) –

          The ARN of the QuickSight resource.

  • RemoveResources (list) –

    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.

        Note

        This is a Tagged Union structure. Only one of the following top level keys can be set: resourceArn.

        • resourceArn (string) –

          The ARN of the QuickSight resource.

Return type:

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.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: resourceArn. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • 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.

Exceptions