Skip to content

create_service_network

create_service_network(
    name: ServiceNetworkName,
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    auth_type: Optional[AuthType] = None,
    tags: Optional[TagMap] = None,
    sharing_config: Optional[SharingConfig] = None,
) -> CreateServiceNetworkResponse

Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.

For more information, see Service networks in the Amazon VPC Lattice User Guide.

Parameters:

  • client_token (Optional[ClientToken], default: None ) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

  • name (ServiceNetworkName) –

    The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

  • auth_type (Optional[AuthType], default: None ) –

    The type of IAM policy.

    • NONE: The resource does not use an IAM policy. This is the default.

    • AWS_IAM: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

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

    The tags for the service network.

  • sharing_config (Optional[SharingConfig], default: None ) –

    Specify if the service network should be enabled for sharing.

Raises:

Source code in docs_src/capo_vpc_lattice/_services/vpc_lattice.py
def create_service_network(
    self,
    name: "capo_vpc_lattice.types.service_network_name.ServiceNetworkName",
    *,
    config_overrides: Optional[VPCLatticeClientConfig] = None,
    client_token: Optional[
        "capo_vpc_lattice.types.client_token.ClientToken"
    ] = None,
    auth_type: Optional["capo_vpc_lattice.types.auth_type.AuthType"] = None,
    tags: Optional["capo_vpc_lattice.types.tag_map.TagMap"] = None,
    sharing_config: Optional[
        "capo_vpc_lattice.types.sharing_config.SharingConfig"
    ] = None,
) -> "capo_vpc_lattice.types.create_service_network_response.CreateServiceNetworkResponse":
    """<p>Creates a service network. A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc-lattice/latest/ug/service-networks.html">Service networks</a> in the <i>Amazon VPC Lattice User Guide</i>.</p>

    Args:
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.</p>
        name: <p>The name of the service network. The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.</p>
        auth_type: <p>The type of IAM policy.</p> <ul> <li> <p> <code>NONE</code>: The resource does not use an IAM policy. This is the default.</p> </li> <li> <p> <code>AWS_IAM</code>: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.</p> </li> </ul>
        tags: <p>The tags for the service network.</p>
        sharing_config: <p>Specify if the service network should be enabled for sharing.</p>

    Raises:
        capo_vpc_lattice.errors.access_denied_exception.AccessDeniedException: <p>The user does not have sufficient access to perform this action.</p>
        capo_vpc_lattice.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.</p>
        capo_vpc_lattice.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred while processing the request.</p>
        capo_vpc_lattice.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resource that does not exist.</p>
        capo_vpc_lattice.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded.</p>
        capo_vpc_lattice.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_vpc_lattice.errors.validation_exception.ValidationException: <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_vpc_lattice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_vpc_lattice.types.create_service_network_request.CreateServiceNetworkRequest]",
    ) -> OperationResponse[
        "capo_vpc_lattice.types.create_service_network_response.CreateServiceNetworkResponse"
    ]:
        import capo_vpc_lattice._operations.mercury_control_plane.create_service_network

        output, http_response = (
            capo_vpc_lattice._operations.mercury_control_plane.create_service_network.create_service_network(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateServiceNetwork")
    )
    input_: capo_vpc_lattice.types.create_service_network_request.CreateServiceNetworkRequest = {
        "name": name
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if auth_type is not None:
        input_["auth_type"] = auth_type
    if tags is not None:
        input_["tags"] = tags
    if sharing_config is not None:
        input_["sharing_config"] = sharing_config

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