MediaLive / Client / describe_network

describe_network#

MediaLive.Client.describe_network(**kwargs)#

Get details about a Network.

Request Syntax

response = client.describe_network(
    NetworkId='string'
)

Parameters:

NetworkId (string) – [REQUIRED] The ID of the network.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AssociatedClusterIds': [
        'string',
    ],
    'Id': 'string',
    'IpPools': [
        {
            'Cidr': 'string'
        },
    ],
    'Name': 'string',
    'Routes': [
        {
            'Cidr': 'string',
            'Gateway': 'string'
        },
    ],
    'State': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'DELETING'|'IDLE'|'IN_USE'|'UPDATING'|'DELETE_FAILED'|'DELETED'
}

Response Structure

(dict) – Details for one network.
- Arn (string) – The ARN of this Network. It is automatically assigned when the Network is created.
- AssociatedClusterIds (list) – Placeholder documentation for __listOf__string
  - (string) – Placeholder documentation for __string
- Id (string) – The ID of the Network. Unique in the AWS account. The ID is the resource-id portion of the ARN.
- IpPools (list) – An array of IpPools in your organization’s network that identify a collection of IP addresses in this network that are reserved for use in MediaLive Anywhere. MediaLive Anywhere uses these IP addresses for Push inputs (in both Bridge and NAT networks) and for output destinations (only in Bridge networks). Each IpPool specifies one CIDR block.
  - (dict) – Used in DescribeNetworkResult, DescribeNetworkSummary, UpdateNetworkResult.
    - Cidr (string) – A CIDR block of IP addresses that are reserved for MediaLive Anywhere.
- Name (string) – The name that you specified for the Network.
- Routes (list) – An array of routes that MediaLive Anywhere needs to know about in order to route encoding traffic.
  - (dict) – Used in DescribeNetworkResult, DescribeNetworkSummary, UpdateNetworkResult.
    - Cidr (string) – A CIDR block for one Route.
    - Gateway (string) – The IP address of the Gateway for this route, if applicable.
- State (string) – The current state of the Network. Only MediaLive Anywhere can change the state.

Exceptions

MediaLive.Client.exceptions.BadRequestException
MediaLive.Client.exceptions.InternalServerErrorException
MediaLive.Client.exceptions.ForbiddenException
MediaLive.Client.exceptions.BadGatewayException
MediaLive.Client.exceptions.NotFoundException
MediaLive.Client.exceptions.GatewayTimeoutException
MediaLive.Client.exceptions.TooManyRequestsException