create_scope_snapshot `async` ¶

create_scope_snapshot(
    scope_identifier: ScopeIdentifier,
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    tags: Optional[TagMap] = None,
) -> CreateScopeSnapshotOutput

Creates a snapshot of the current published version of the specified scope.

Parameters:

scope_identifier (ScopeIdentifier) –

The identifier of the scope. This is the scope's Amazon Resource Name (ARN).
client_token (Optional[IdempotencyToken], default: None ) –

A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.
tags (Optional[TagMap], default: None ) –

The tags to add to the snapshot when it is created.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
ConflictException –

The request conflicts with the current state of the resource. For example, the resource was modified concurrently, or it is in a state that does not allow the requested operation.
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.
ServiceQuotaExceededException –

The request would exceed a service quota.
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:

Create a scope snapshot Creates an immutable snapshot of the current published version of a scope. The snapshot is addressable by a version-qualified ARN.

>>> await client.create_scope_snapshot(scope_identifier='arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123', client_token='550e8400-e29b-41d4-a716-446655440010')

Source code in docs_src/capo_network_security_manager/_services/async_network_security_manager.py

async def create_scope_snapshot(
    self,
    scope_identifier: "capo_network_security_manager.types.scope_identifier.ScopeIdentifier",
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
    client_token: Optional[
        "capo_network_security_manager.types.idempotency_token.IdempotencyToken"
    ] = None,
    tags: Optional["capo_network_security_manager.types.tag_map.TagMap"] = None,
) -> "capo_network_security_manager.types.create_scope_snapshot_output.CreateScopeSnapshotOutput":
    """<p>Creates a snapshot of the current published version of the specified scope.</p>

    Args:
        scope_identifier: <p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>
        client_token: <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>
        tags: <p>The tags to add to the snapshot when it is created.</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.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. For example, the resource was modified concurrently, or it is in a state that does not allow the requested operation.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed a service quota.</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:
        Create a scope snapshot
        Creates an immutable snapshot of the current published version of a scope. The snapshot is addressable by a version-qualified ARN.

        >>> await client.create_scope_snapshot(scope_identifier='arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123', client_token='550e8400-e29b-41d4-a716-446655440010')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_network_security_manager.types.create_scope_snapshot_input.CreateScopeSnapshotInput]",
    ) -> AsyncOperationResponse[
        "capo_network_security_manager.types.create_scope_snapshot_output.CreateScopeSnapshotOutput"
    ]:
        import capo_network_security_manager._operations.piccolo_customer_api_service.create_scope_snapshot

        (
            output,
            http_response,
        ) = await capo_network_security_manager._operations.piccolo_customer_api_service.create_scope_snapshot.async_create_scope_snapshot(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateScopeSnapshot")
    )
    input_: capo_network_security_manager.types.create_scope_snapshot_input.CreateScopeSnapshotInput = {
        "scope_identifier": scope_identifier
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_scope_snapshot async ¶

create_scope_snapshot `async` ¶