Athena / Client / get_capacity_assignment_configuration

get_capacity_assignment_configuration#

Athena.Client.get_capacity_assignment_configuration(**kwargs)#

Gets the capacity assignment configuration for a capacity reservation, if one exists.

See also: AWS API Documentation

Request Syntax

response = client.get_capacity_assignment_configuration(
    CapacityReservationName='string'
)
Parameters:

CapacityReservationName (string) –

[REQUIRED]

The name of the capacity reservation to retrieve the capacity assignment configuration for.

Return type:

dict

Returns:

Response Syntax

{
    'CapacityAssignmentConfiguration': {
        'CapacityReservationName': 'string',
        'CapacityAssignments': [
            {
                'WorkGroupNames': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

  • (dict) –

    • CapacityAssignmentConfiguration (dict) –

      The requested capacity assignment configuration for the specified capacity reservation.

      • CapacityReservationName (string) –

        The name of the reservation that the capacity assignment configuration is for.

      • CapacityAssignments (list) –

        The list of assignments that make up the capacity assignment configuration.

        • (dict) –

          A mapping between one or more workgroups and a capacity reservation.

          • WorkGroupNames (list) –

            The list of workgroup names for the capacity assignment.

            • (string) –

Exceptions