get_inventory_schema ¶

def get_inventory_schema(
    self,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    type_name: Optional[
        "capo_ssm.types.inventory_item_type_name_filter.InventoryItemTypeNameFilter"
    ] = None,
    next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_ssm.types.get_inventory_schema_max_results.GetInventorySchemaMaxResults"
    ] = None,
    aggregator: Optional[
        "capo_ssm.types.aggregator_schema_only.AggregatorSchemaOnly"
    ] = None,
    sub_type: Optional["capo_ssm.types.is_sub_type_schema.IsSubTypeSchema"] = None,
) -> "capo_ssm.types.get_inventory_schema_result.GetInventorySchemaResult":
    """<p>Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.</p>

    Args:
        type_name: <p>The type of inventory item to return.</p>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
        max_results: <p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p>
        aggregator: <p>Returns inventory schemas that support aggregation. For example, this call returns the <code>AWS:InstanceInformation</code> type, because it supports aggregation based on the <code>PlatformName</code>, <code>PlatformType</code>, and <code>PlatformVersion</code> attributes.</p>
        sub_type: <p>Returns the sub-type schema for a specified inventory type.</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_next_token.InvalidNextToken: <p>The specified token isn't valid.</p>
        capo_ssm.errors.invalid_type_name_exception.InvalidTypeNameException: <p>The parameter type name isn't valid.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.get_inventory_schema_request.GetInventorySchemaRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.get_inventory_schema_result.GetInventorySchemaResult"
    ]:
        import capo_ssm._operations.amazon_ssm.get_inventory_schema

        output, http_response = (
            capo_ssm._operations.amazon_ssm.get_inventory_schema.get_inventory_schema(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInventorySchema")
    )
    input_: capo_ssm.types.get_inventory_schema_request.GetInventorySchemaRequest = {}
    if type_name is not None:
        input_["type_name"] = type_name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if aggregator is not None:
        input_["aggregator"] = aggregator
    if sub_type is not None:
        input_["sub_type"] = sub_type

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