Skip to content

create_deployment async

create_deployment(
    deployment_name: DeploymentName,
    deployment_configuration: DeploymentConfiguration,
    associated_policy_list: PolicyReferenceList,
    associated_scope_list: ScopeReferenceList,
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    deployment_description: Optional[Description] = None,
    is_published: Optional[IsPublished] = None,
    tags: Optional[TagMap] = None,
) -> CreateDeploymentOutput

Creates a deployment. A deployment applies one or more policies to the accounts and resources selected by a scope. Use isPublished to create the deployment in published (ACTIVE) or draft (DRAFT) state. The response includes coverage information and any warnings about the deployment.

Parameters:

  • 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.

  • deployment_name (DeploymentName) –

    The name of the deployment.

  • deployment_description (Optional[Description], default: None ) –

    A description of the deployment.

  • deployment_configuration (DeploymentConfiguration) –

    The configuration settings for the deployment.

  • associated_policy_list (PolicyReferenceList) –

    The policies associated with the deployment.

  • associated_scope_list (ScopeReferenceList) –

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

  • is_published (Optional[IsPublished], default: None ) –

    Specifies whether to publish the resource. When true, the resource is saved in published (ACTIVE) state. When false, it is saved as a draft (DRAFT). Default: true.

  • tags (Optional[TagMap], default: None ) –

    The tags to add to the resource 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.

  • ServiceQuotaExceededException –

    The request would exceed a service quota.

  • ServiceUnavailableException –

    The service is temporarily unavailable. This is a retryable error.

  • TagPolicyViolationException –

    The request violates a tag policy that is in effect for the account or organization.

  • 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 deployment Creates a new deployment in draft state.

>>> await client.create_deployment(client_token='550e8400-e29b-41d4-a716-446655440003', deployment_name='prod-us-east-1-deployment', deployment_description='Production deployment for US East 1 region', associated_policy_list=[{'policyIdentifier': 'arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789'}], associated_scope_list=[{'scopeIdentifier': 'arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123'}], deployment_configuration={'enableCrossAccountVisibility': False}, is_published=False)
Source code in docs_src/capo_network_security_manager/_services/async_network_security_manager.py
async def create_deployment(
    self,
    deployment_name: "capo_network_security_manager.types.deployment_name.DeploymentName",
    deployment_configuration: "capo_network_security_manager.types.deployment_configuration.DeploymentConfiguration",
    associated_policy_list: "capo_network_security_manager.types.policy_reference_list.PolicyReferenceList",
    associated_scope_list: "capo_network_security_manager.types.scope_reference_list.ScopeReferenceList",
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
    client_token: Optional[
        "capo_network_security_manager.types.idempotency_token.IdempotencyToken"
    ] = None,
    deployment_description: Optional[
        "capo_network_security_manager.types.description.Description"
    ] = None,
    is_published: Optional[
        "capo_network_security_manager.types.is_published.IsPublished"
    ] = None,
    tags: Optional["capo_network_security_manager.types.tag_map.TagMap"] = None,
) -> "capo_network_security_manager.types.create_deployment_output.CreateDeploymentOutput":
    """<p>Creates a deployment. A deployment applies one or more policies to the accounts and resources selected by a scope. Use <code>isPublished</code> to create the deployment in published (<code>ACTIVE</code>) or draft (<code>DRAFT</code>) state. The response includes coverage information and any warnings about the deployment.</p>

    Args:
        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>
        deployment_name: <p>The name of the deployment.</p>
        deployment_description: <p>A description of the deployment.</p>
        deployment_configuration: <p>The configuration settings for the deployment.</p>
        associated_policy_list: <p>The policies associated with the deployment.</p>
        associated_scope_list: <p>The scope associated with the deployment. A deployment has exactly one scope.</p>
        is_published: <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>). Default: <code>true</code>.</p>
        tags: <p>The tags to add to the resource 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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed a service quota.</p>
        capo_network_security_manager.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable. This is a retryable error.</p>
        capo_network_security_manager.errors.tag_policy_violation_exception.TagPolicyViolationException: <p>The request violates a tag policy that is in effect for the account or organization.</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 deployment
        Creates a new deployment in draft state.

        >>> await client.create_deployment(client_token='550e8400-e29b-41d4-a716-446655440003', deployment_name='prod-us-east-1-deployment', deployment_description='Production deployment for US East 1 region', associated_policy_list=[{'policyIdentifier': 'arn:aws:network-security-manager:us-east-1:123456789012:policy:xyz789'}], associated_scope_list=[{'scopeIdentifier': 'arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123'}], deployment_configuration={'enableCrossAccountVisibility': False}, is_published=False)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_network_security_manager.types.create_deployment_input.CreateDeploymentInput]",
    ) -> AsyncOperationResponse[
        "capo_network_security_manager.types.create_deployment_output.CreateDeploymentOutput"
    ]:
        import capo_network_security_manager._operations.piccolo_customer_api_service.create_deployment

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateDeployment")
    )
    input_: capo_network_security_manager.types.create_deployment_input.CreateDeploymentInput = {
        "deployment_name": deployment_name,
        "deployment_configuration": deployment_configuration,
        "associated_policy_list": associated_policy_list,
        "associated_scope_list": associated_scope_list,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if deployment_description is not None:
        input_["deployment_description"] = deployment_description
    if is_published is not None:
        input_["is_published"] = is_published
    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