Skip to content

list_db_system_shapes

list_db_system_shapes(
    *,
    config_overrides: Optional[odbClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
    availability_zone: Optional[str] = None,
    availability_zone_id: Optional[str] = None,
    shape_family: Optional[str] = None,
) -> ListDbSystemShapesOutput

Returns information about the shapes that are available for an Exadata infrastructure.

Parameters:

  • max_results (Optional[int], default: None ) –

    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

    Default: 10

  • next_token (Optional[str], default: None ) –

    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

  • availability_zone (Optional[str], default: None ) –

    The logical name of the AZ, for example, us-east-1a. This name varies depending on the account.

  • availability_zone_id (Optional[str], default: None ) –

    The physical ID of the AZ, for example, use1-az4. This ID persists across accounts.

  • shape_family (Optional[str], default: None ) –

    The shape family to filter results by.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

  • InternalServerException –

    Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The request has failed validation because it is missing required fields or has invalid inputs.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_odb/_services/odb.py
def list_db_system_shapes(
    self,
    *,
    config_overrides: Optional[odbClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
    availability_zone: Optional[str] = None,
    availability_zone_id: Optional[str] = None,
    shape_family: Optional[str] = None,
) -> "capo_odb.types.list_db_system_shapes_output.ListDbSystemShapesOutput":
    """<p>Returns information about the shapes that are available for an Exadata infrastructure.</p>

    Args:
        max_results: <p>The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.</p> <p>Default: <code>10</code> </p>
        next_token: <p>The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.</p>
        availability_zone: <p>The logical name of the AZ, for example, us-east-1a. This name varies depending on the account.</p>
        availability_zone_id: <p>The physical ID of the AZ, for example, use1-az4. This ID persists across accounts.</p>
        shape_family: <p>The shape family to filter results by.</p>

    Raises:
        capo_odb.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.</p>
        capo_odb.errors.internal_server_exception.InternalServerException: <p>Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.</p>
        capo_odb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_odb.errors.validation_exception.ValidationException: <p>The request has failed validation because it is missing required fields or has invalid inputs.</p>
        capo_odb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_odb.types.list_db_system_shapes_input.ListDbSystemShapesInput]",
    ) -> OperationResponse[
        "capo_odb.types.list_db_system_shapes_output.ListDbSystemShapesOutput"
    ]:
        import capo_odb._operations.odb.list_db_system_shapes

        output, http_response = (
            capo_odb._operations.odb.list_db_system_shapes.list_db_system_shapes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDbSystemShapes")
    )
    input_: capo_odb.types.list_db_system_shapes_input.ListDbSystemShapesInput = {}
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if availability_zone is not None:
        input_["availability_zone"] = availability_zone
    if availability_zone_id is not None:
        input_["availability_zone_id"] = availability_zone_id
    if shape_family is not None:
        input_["shape_family"] = shape_family

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output