Skip to content

list_template_snapshots

list_template_snapshots(
    template_identifier: TemplateIdentifier,
    *,
    config_overrides: Optional[NetworkSecurityManagerClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListTemplateSnapshotsOutput

Lists the snapshots of the specified template.

Parameters:

  • template_identifier (TemplateIdentifier) –

    The identifier of the template. This is the template's Amazon Resource Name (ARN).

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

    The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.

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

    The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.

Raises:

  • AccessDeniedException –

    You do not have sufficient permissions to perform this action.

  • InternalServerException –

    The request processing failed because of an internal error in the service. This is a retryable error.

  • ResourceNotFoundException –

    The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.

  • ThrottlingException –

    The request was denied because of request throttling. Reduce your request rate and try again.

  • ValidationException –

    The request failed validation. For details, see the reason and fieldList members of the response.

  • UnknownServiceError –

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

Examples:

List the snapshots of a template Lists the immutable snapshots that have been created for a template.

>>> client.list_template_snapshots(template_identifier='arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789', max_results=10)
Source code in docs_src/capo_network_security_manager/_services/network_security_manager.py
def list_template_snapshots(
    self,
    template_identifier: "capo_network_security_manager.types.template_identifier.TemplateIdentifier",
    *,
    config_overrides: Optional[NetworkSecurityManagerClientConfig] = None,
    max_results: Optional[
        "capo_network_security_manager.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_network_security_manager.types.next_token.NextToken"
    ] = None,
) -> "capo_network_security_manager.types.list_template_snapshots_output.ListTemplateSnapshotsOutput":
    """<p>Lists the snapshots of the specified template.</p>

    Args:
        template_identifier: <p>The identifier of the template. This is the template's Amazon Resource Name (ARN).</p>
        max_results: <p>The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned <code>nextToken</code> value in a subsequent call.</p>
        next_token: <p>The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.</p>

    Raises:
        capo_network_security_manager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_network_security_manager.errors.internal_server_exception.InternalServerException: <p>The request processing failed because of an internal error in the service. This is a retryable error.</p>
        capo_network_security_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.</p>
        capo_network_security_manager.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Reduce your request rate and try again.</p>
        capo_network_security_manager.errors.validation_exception.ValidationException: <p>The request failed validation. For details, see the <code>reason</code> and <code>fieldList</code> members of the response.</p>
        capo_network_security_manager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List the snapshots of a template
        Lists the immutable snapshots that have been created for a template.

        >>> client.list_template_snapshots(template_identifier='arn:aws:network-security-manager:us-east-1:123456789012:template:xyz789', max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_network_security_manager.types.list_template_snapshots_input.ListTemplateSnapshotsInput]",
    ) -> OperationResponse[
        "capo_network_security_manager.types.list_template_snapshots_output.ListTemplateSnapshotsOutput"
    ]:
        import capo_network_security_manager._operations.piccolo_customer_api_service.list_template_snapshots

        output, http_response = (
            capo_network_security_manager._operations.piccolo_customer_api_service.list_template_snapshots.list_template_snapshots(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListTemplateSnapshots")
    )
    input_: capo_network_security_manager.types.list_template_snapshots_input.ListTemplateSnapshotsInput = {
        "template_identifier": template_identifier
    }
    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