create_network_site

Private5G.Client.create_network_site(**kwargs)

Creates a network site.

See also: AWS API Documentation

Request Syntax

response = client.create_network_site(
    availabilityZone='string',
    availabilityZoneId='string',
    clientToken='string',
    description='string',
    networkArn='string',
    networkSiteName='string',
    pendingPlan={
        'options': [
            {
                'name': 'string',
                'value': 'string'
            },
        ],
        'resourceDefinitions': [
            {
                'count': 123,
                'options': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ],
                'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
            },
        ]
    },
    tags={
        'string': 'string'
    }
)

Parameters

• availabilityZone (string) -- The Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
• availabilityZoneId (string) -- The ID of the Availability Zone that is the parent of this site. You can't change the Availability Zone after you create the site.
• clientToken (string) -- Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
• description (string) -- The description of the site.
• networkArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the network.

• networkSiteName (string) --

  [REQUIRED]

  The name of the site. You can't change the name after you create the site.

• pendingPlan (dict) --

  Information about the pending plan for this site.

  • options (list) --

    The options of the plan.

    • (dict) --

      Information about a name/value pair.

      • name (string) -- [REQUIRED]

        The name of the pair.

      • value (string) --

        The value of the pair.

  • resourceDefinitions (list) --

    The resource definitions of the plan.

    • (dict) --

      Information about a network resource definition.

      • count (integer) -- [REQUIRED]

        The count in the network resource definition.

      • options (list) --

        The options in the network resource definition.

        • (dict) --

          Information about a name/value pair.

          • name (string) -- [REQUIRED]

            The name of the pair.

          • value (string) --

            The value of the pair.

      • type (string) -- [REQUIRED]

        The type in the network resource definition.

• tags (dict) --

  The tags to apply to the network site.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'networkSite': {
        'availabilityZone': 'string',
        'availabilityZoneId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'currentPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'description': 'string',
        'networkArn': 'string',
        'networkSiteArn': 'string',
        'networkSiteName': 'string',
        'pendingPlan': {
            'options': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'resourceDefinitions': [
                {
                    'count': 123,
                    'options': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ],
                    'type': 'RADIO_UNIT'|'DEVICE_IDENTIFIER'
                },
            ]
        },
        'status': 'CREATED'|'PROVISIONING'|'AVAILABLE'|'DEPROVISIONING'|'DELETED',
        'statusReason': 'string'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --

  • networkSite (dict) --

    Information about the network site.

    • availabilityZone (string) --

      The parent Availability Zone for the network site.

    • availabilityZoneId (string) --

      The parent Availability Zone ID for the network site.

    • createdAt (datetime) --

      The creation time of the network site.

    • currentPlan (dict) --

      The current plan of the network site.

      • options (list) --

        The options of the plan.

        • (dict) --

          Information about a name/value pair.

          • name (string) --

            The name of the pair.

          • value (string) --

            The value of the pair.

      • resourceDefinitions (list) --

        The resource definitions of the plan.

        • (dict) --

          Information about a network resource definition.

          • count (integer) --

            The count in the network resource definition.

          • options (list) --

            The options in the network resource definition.

            • (dict) --

              Information about a name/value pair.

              • name (string) --

                The name of the pair.

              • value (string) --

                The value of the pair.

          • type (string) --

            The type in the network resource definition.

    • description (string) --

      The description of the network site.

    • networkArn (string) --

      The Amazon Resource Name (ARN) of the network to which the network site belongs.

    • networkSiteArn (string) --

      The Amazon Resource Name (ARN) of the network site.

    • networkSiteName (string) --

      The name of the network site.

    • pendingPlan (dict) --

      The pending plan of the network site.

      • options (list) --

        The options of the plan.

        • (dict) --

          Information about a name/value pair.

          • name (string) --

            The name of the pair.

          • value (string) --

            The value of the pair.

      • resourceDefinitions (list) --

        The resource definitions of the plan.

        • (dict) --

          Information about a network resource definition.

          • count (integer) --

            The count in the network resource definition.

          • options (list) --

            The options in the network resource definition.

            • (dict) --

              Information about a name/value pair.

              • name (string) --

                The name of the pair.

              • value (string) --

                The value of the pair.

          • type (string) --

            The type in the network resource definition.

    • status (string) --

      The status of the network site.

    • statusReason (string) --

      The status reason of the network site.

  • tags (dict) --

    The network site tags.

    • (string) --
      • (string) --

Exceptions

• Private5G.Client.exceptions.ResourceNotFoundException
• Private5G.Client.exceptions.ValidationException
• Private5G.Client.exceptions.InternalServerException