Skip to content

list_document_versions

list_document_versions(
    name: DocumentARN,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListDocumentVersionsResult

List all versions for a document.

Parameters:

  • name (DocumentARN) –

    The name of the document. You can specify an Amazon Resource Name (ARN).

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

    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.

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

    The token for the next set of items to return. (You received this token from a previous call.)

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def list_document_versions(
    self,
    name: "capo_ssm.types.document_arn.DocumentARN",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    max_results: Optional["capo_ssm.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_ssm.types.next_token.NextToken"] = None,
) -> "capo_ssm.types.list_document_versions_result.ListDocumentVersionsResult":
    """<p>List all versions for a document.</p>

    Args:
        name: <p>The name of the document. You can specify an Amazon Resource Name (ARN).</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>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>

    Raises:
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_document.InvalidDocument: <p>The specified SSM document doesn't exist.</p>
        capo_ssm.errors.invalid_next_token.InvalidNextToken: <p>The specified token 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.list_document_versions_request.ListDocumentVersionsRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.list_document_versions_result.ListDocumentVersionsResult"
    ]:
        import capo_ssm._operations.amazon_ssm.list_document_versions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListDocumentVersions")
    )
    input_: capo_ssm.types.list_document_versions_request.ListDocumentVersionsRequest = {
        "name": name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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