NetworkSecurityManagerCustomerAPI / Client / create_deployment_snapshot

create_deployment_snapshot

NetworkSecurityManagerCustomerAPI.Client.create_deployment_snapshot(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_deployment_snapshot(
    deploymentIdentifier='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • deploymentIdentifier (string) –

    [REQUIRED]

    The identifier of the deployment. This is the deployment’s Amazon Resource Name (ARN).

  • clientToken (string) –

    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.

    This field is autopopulated if not provided.

  • tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'deploymentId': 'string',
    'deploymentArn': 'string',
    'deploymentName': 'string',
    'deploymentDescription': 'string',
    'status': 'DRAFT'|'ACTIVE'|'DISABLED',
    'deploymentConfiguration': {
        'enableCrossAccountVisibility': True|False
    },
    'associatedPolicyList': [
        {
            'policyArn': 'string'
        },
    ],
    'associatedScopeList': [
        {
            'scopeArn': 'string'
        },
    ],
    'version': 'string',
    'updateToken': 'string',
    'isSnapshot': True|False,
    'hasPublishedVersion': True|False,
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • deploymentId (string) –

      The service-generated id of the deployment.

    • deploymentArn (string) –

      The Amazon Resource Name (ARN) of the deployment.

    • deploymentName (string) –

      The name of the deployment.

    • deploymentDescription (string) –

      A description of the deployment.

    • status (string) –

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

    • deploymentConfiguration (dict) –

      The configuration settings for the deployment.

      • enableCrossAccountVisibility (boolean) –

        Specifies whether aggregate synchronization status details for the resources covered by this deployment are visible across accounts. Default: false.

    • associatedPolicyList (list) –

      The policies associated with the deployment.

      • (dict) –

        An association between a deployment and a policy, as returned in outputs. The corresponding request structure is PolicyReference.

        • policyArn (string) –

          The ARN of the associated policy, including its version qualifier when a specific published version is pinned (for example, ...:policy:abc123:3).

    • associatedScopeList (list) –

      The scope associated with the deployment. A deployment has exactly one scope.

      • (dict) –

        An association between a deployment and a scope, as returned in outputs. The corresponding request structure is ScopeReference.

        • scopeArn (string) –

          The ARN of the associated scope.

    • version (string) –

      The version of the resource.

    • updateToken (string) –

      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

    • isSnapshot (boolean) –

      Specifies whether the resource is a snapshot of a published version.

    • hasPublishedVersion (boolean) –

      Specifies whether a published version of the resource exists.

    • updatedAt (datetime) –

      The time when the snapshot was created.

Exceptions