computing

Table of Contents

Client

class computing.Client

A low-level client representing NIFCLOUD Computing:

client = session.create_client('computing')

These are the available methods:

allocate_address(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.allocate_address(
    InstanceId='string',
    NiftyPrivateIp=True|False,
    Placement={
        'AvailabilityZone': 'string',
        'RegionName': 'string'
    }
)
Parameters:
  • InstanceId (string) –
  • NiftyPrivateIp (boolean) –
  • Placement (dict) –
    • AvailabilityZone (string) –
    • RegionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AllocationId': 'string',
    'Domain': 'string',
    'Placement': {
        'AvailabilityZone': 'string',
        'RegionName': 'string'
    },
    'PrivateIpAddress': 'string',
    'PublicIp': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • AllocationId (string) –
    • Domain (string) –
    • Placement (dict) –
      • AvailabilityZone (string) –
      • RegionName (string) –
    • PrivateIpAddress (string) –
    • PublicIp (string) –
    • RequestId (string) –

associate_address(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.associate_address(
    InstanceId='string',
    NiftyReboot='string',
    PrivateIpAddress='string',
    PublicIp='string'
)
Parameters:
  • InstanceId (string) –
  • NiftyReboot (string) –
  • PrivateIpAddress (string) –
  • PublicIp (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string',
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • AssociationId (string) –
    • RequestId (string) –
    • Return (boolean) –

associate_route_table(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.associate_route_table(
    Agreement=True|False,
    RouteTableId='string',
    RouterId='string',
    RouterName='string'
)
Parameters:
  • Agreement (boolean) –
  • RouteTableId (string) –
  • RouterId (string) –
  • RouterName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • AssociationId (string) –
    • RequestId (string) –

associate_users(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.associate_users(
    FunctionName='string',
    Users=[
        {
            'UserId': 'string'
        },
    ]
)
Parameters:
  • FunctionName (string) –
  • Users (list) –
    • (dict) –
      • UserId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AssociateUsersResult': {'... recursive ...'},
    'ResponseMetadata': {
        'RequestId': 'string'
    },
    'Users': [
        {
            'UserId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • AssociateUsersResult (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –
    • Users (list) –
      • (dict) –
        • UserId (string) –

attach_volume(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.attach_volume(
    InstanceId='string',
    VolumeId='string'
)
Parameters:
  • InstanceId (string) –
  • VolumeId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AttachTime': datetime(2015, 1, 1),
    'Device': 'string',
    'InstanceId': 'string',
    'InstanceUniqueId': 'string',
    'RequestId': 'string',
    'Status': 'string',
    'VolumeId': 'string'
}

Response Structure

  • (dict) –
    • AttachTime (datetime) –
    • Device (string) –
    • InstanceId (string) –
    • InstanceUniqueId (string) –
    • RequestId (string) –
    • Status (string) –
    • VolumeId (string) –

authorize_security_group_ingress(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.authorize_security_group_ingress(
    GroupName='string',
    IpPermissions=[
        {
            'Description': 'string',
            'FromPort': 123,
            'InOut': 'string',
            'IpProtocol': 'string',
            'RequestGroups': [
                {
                    'GroupName': 'string'
                },
            ],
            'RequestIpRanges': [
                {
                    'CidrIp': 'string'
                },
            ],
            'ToPort': 123
        },
    ]
)
Parameters:
  • GroupName (string) –
  • IpPermissions (list) –
    • (dict) –
      • Description (string) –
      • FromPort (integer) –
      • InOut (string) –
      • IpProtocol (string) –
      • RequestGroups (list) –
        • (dict) –
          • GroupName (string) –
      • RequestIpRanges (list) –
        • (dict) –
          • CidrIp (string) –
      • ToPort (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters:operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you’d normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns:True if the operation can be paginated, False otherwise.
cancel_copy_instances(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.cancel_copy_instances(
    InstanceId='string'
)
Parameters:InstanceId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • RequestId (string) –
cancel_upload(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.cancel_upload(
    ConversionTaskId='string'
)
Parameters:ConversionTaskId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
clear_load_balancer_session(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.clear_load_balancer_session(
    InstancePort=123,
    LoadBalancerName='string',
    LoadBalancerPort=123
)
Parameters:
  • InstancePort (integer) –
  • LoadBalancerName (string) –
  • LoadBalancerPort (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

configure_health_check(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.configure_health_check(
    HealthCheck={
        'Interval': 123,
        'Target': 'string',
        'UnhealthyThreshold': 123
    },
    InstancePort=123,
    LoadBalancerName='string',
    LoadBalancerPort=123
)
Parameters:
  • HealthCheck (dict) –
    • Interval (integer) –
    • Target (string) –
    • UnhealthyThreshold (integer) –
  • InstancePort (integer) –
  • LoadBalancerName (string) –
  • LoadBalancerPort (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'ConfigureHealthCheckResult': {'... recursive ...'},
    'HealthCheck': {
        'HealthyThreshold': 123,
        'InstanceStates': [
            {
                'Description': 'string',
                'InstanceId': 'string',
                'InstanceUniqueId': 'string',
                'ReasonCode': 'string',
                'State': 'string'
            },
        ],
        'Interval': 123,
        'Target': 'string',
        'Timeout': 123,
        'UnhealthyThreshold': 123
    },
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • ConfigureHealthCheckResult (dict) –
    • HealthCheck (dict) –
      • HealthyThreshold (integer) –
      • InstanceStates (list) –
        • (dict) –
          • Description (string) –
          • InstanceId (string) –
          • InstanceUniqueId (string) –
          • ReasonCode (string) –
          • State (string) –
      • Interval (integer) –
      • Target (string) –
      • Timeout (integer) –
      • UnhealthyThreshold (integer) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

copy_instances(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.copy_instances(
    CopyCount=123,
    CopyInstance={
        'AccountingType': 'string',
        'InstanceName': 'string',
        'InstanceType': 'string',
        'IpType': 'string',
        'RequestLoadBalancers': [
            {
                'InstancePort': 123,
                'LoadBalancerName': 'string',
                'LoadBalancerPort': 123,
                'Name': 'string'
            },
        ],
        'RequestPlacementStruct': {
            'AvailabilityZone': 'string',
            'RegionName': 'string'
        },
        'RequestSecurityGroup': [
            'string',
        ]
    },
    InstanceId='string',
    NetworkInterface=[
        {
            'DeviceIndex': 123,
            'Dhcp': True|False,
            'DhcpConfigId': 'string',
            'DhcpOptionsId': 'string',
            'IpAddress': 'string',
            'IsVipNetwork': True|False,
            'NetworkId': 'string',
            'NetworkName': 'string',
            'RequestSecurityGroupId': [
                'string',
            ]
        },
    ]
)
Parameters:
  • CopyCount (integer) –
  • CopyInstance (dict) –
    • AccountingType (string) –
    • InstanceName (string) –
    • InstanceType (string) –
    • IpType (string) –
    • RequestLoadBalancers (list) –
      • (dict) –
        • InstancePort (integer) –
        • LoadBalancerName (string) –
        • LoadBalancerPort (integer) –
        • Name (string) –
    • RequestPlacementStruct (dict) –
      • AvailabilityZone (string) –
      • RegionName (string) –
    • RequestSecurityGroup (list) –
      • (string) –
  • InstanceId (string) –
  • NetworkInterface (list) –
    • (dict) –
      • DeviceIndex (integer) –
      • Dhcp (boolean) –
      • DhcpConfigId (string) –
      • DhcpOptionsId (string) –
      • IpAddress (string) –
      • IsVipNetwork (boolean) –
      • NetworkId (string) –
      • NetworkName (string) –
      • RequestSecurityGroupId (list) –
        • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'CopyInstanceSet': [
        {
            'InstanceId': 'string',
            'InstanceState': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • CopyInstanceSet (list) –
      • (dict) –
        • InstanceId (string) –
        • InstanceState (string) –
        • InstanceUniqueId (string) –
    • RequestId (string) –

create_customer_gateway(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_customer_gateway(
    IpAddress='string',
    NiftyCustomerGatewayDescription='string',
    NiftyCustomerGatewayName='string',
    NiftyLanSideCidrBlock='string',
    NiftyLanSideIpAddress='string'
)
Parameters:
  • IpAddress (string) –
  • NiftyCustomerGatewayDescription (string) –
  • NiftyCustomerGatewayName (string) –
  • NiftyLanSideCidrBlock (string) –
  • NiftyLanSideIpAddress (string) –
Return type:

dict

Returns:

Response Syntax

{
    'CustomerGateway': {
        'BgpAsn': 'string',
        'CustomerGatewayId': 'string',
        'IpAddress': 'string',
        'NiftyCustomerGatewayDescription': 'string',
        'NiftyCustomerGatewayName': 'string',
        'NiftyLanSideCidrBlock': 'string',
        'NiftyLanSideIpAddress': 'string',
        'State': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string'
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • CustomerGateway (dict) –
      • BgpAsn (string) –
      • CustomerGatewayId (string) –
      • IpAddress (string) –
      • NiftyCustomerGatewayDescription (string) –
      • NiftyCustomerGatewayName (string) –
      • NiftyLanSideCidrBlock (string) –
      • NiftyLanSideIpAddress (string) –
      • State (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –
      • Type (string) –
    • RequestId (string) –

create_dhcp_options(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_dhcp_options(
    DhcpConfiguration=[
        {
            'Key': 'string',
            'RequestValue': [
                'string',
            ]
        },
    ]
)
Parameters:DhcpConfiguration (list) –
  • (dict) –
    • Key (string) –
    • RequestValue (list) –
      • (string) –
Return type:dict
Returns:Response Syntax
{
    'DhcpOptions': {
        'DhcpConfigurationSetType': [
            {
                'Key': 'string',
                'ValueSet': [
                    {
                        'Value': 'string'
                    },
                ]
            },
        ],
        'DhcpOptionsId': 'string'
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • DhcpOptions (dict) –
      • DhcpConfigurationSetType (list) –
        • (dict) –
          • Key (string) –
          • ValueSet (list) –
            • (dict) –
              • Value (string) –
      • DhcpOptionsId (string) –
    • RequestId (string) –
create_image(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_image(
    Description='string',
    InstanceId='string',
    LeftInstance=True|False,
    Name='string',
    Placement={
        'AvailabilityZone': 'string',
        'RegionName': 'string'
    }
)
Parameters:
  • Description (string) –
  • InstanceId (string) –
  • LeftInstance (boolean) –
  • Name (string) –
  • Placement (dict) –
    • AvailabilityZone (string) –
    • RegionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'ImageId': 'string',
    'ImageState': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • ImageId (string) –
    • ImageState (string) –
    • RequestId (string) –

create_key_pair(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_key_pair(
    Description='string',
    KeyName='string',
    Password='string'
)
Parameters:
  • Description (string) –
  • KeyName (string) –
  • Password (string) –
Return type:

dict

Returns:

Response Syntax

{
    'KeyFingerprint': 'string',
    'KeyMaterial': 'string',
    'KeyName': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • KeyFingerprint (string) –
    • KeyMaterial (string) –
    • KeyName (string) –
    • RequestId (string) –

create_load_balancer(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_load_balancer(
    AccountingType='string',
    AvailabilityZones=[
        'string',
    ],
    IpVersion='string',
    Listeners=[
        {
            'BalancingType': 'string',
            'Description': 'string',
            'ElasticLoadBalancerPort': 123,
            'InstancePort': 123,
            'LoadBalancerPort': 123,
            'Protocol': 'string',
            'RequestHealthCheckStruct': {
                'Interval': 123,
                'Target': 'string',
                'UnhealthyThreshold': 123
            },
            'RequestInstances': [
                {
                    'InstanceId': 'string',
                    'InstanceUniqueId': 'string'
                },
            ],
            'RequestSessionStruct': {
                'RequestStickinessPolicyStruct': {
                    'Enable': True|False,
                    'ExpirationPeriod': 123,
                    'Method': 'string'
                }
            },
            'RequestSorryPageStruct': {
                'Enable': True|False,
                'RedirectUrl': 'string'
            },
            'SSLCertificateId': 'string'
        },
    ],
    LoadBalancerName='string',
    NetworkVolume=123
)
Parameters:
  • AccountingType (string) –
  • AvailabilityZones (list) –
    • (string) –
  • IpVersion (string) –
  • Listeners (list) –
    • (dict) –
      • BalancingType (string) –
      • Description (string) –
      • ElasticLoadBalancerPort (integer) –
      • InstancePort (integer) –
      • LoadBalancerPort (integer) –
      • Protocol (string) –
      • RequestHealthCheckStruct (dict) –
        • Interval (integer) –
        • Target (string) –
        • UnhealthyThreshold (integer) –
      • RequestInstances (list) –
        • (dict) –
          • InstanceId (string) –
          • InstanceUniqueId (string) –
      • RequestSessionStruct (dict) –
        • RequestStickinessPolicyStruct (dict) –
          • Enable (boolean) –
          • ExpirationPeriod (integer) –
          • Method (string) –
      • RequestSorryPageStruct (dict) –
        • Enable (boolean) –
        • RedirectUrl (string) –
      • SSLCertificateId (string) –
  • LoadBalancerName (string) –
  • NetworkVolume (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'CreateLoadBalancerResult': {'... recursive ...'},
    'DNSName': 'string',
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • CreateLoadBalancerResult (dict) –
    • DNSName (string) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

create_route(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_route(
    DestinationCidrBlock='string',
    IpAddress='string',
    NetworkId='string',
    NetworkName='string',
    RouteTableId='string'
)
Parameters:
  • DestinationCidrBlock (string) –
  • IpAddress (string) –
  • NetworkId (string) –
  • NetworkName (string) –
  • RouteTableId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

create_route_table()

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_route_table()
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'RouteTable': {
        'RouteTableId': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • RouteTable (dict) –
      • RouteTableId (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –
create_security_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_security_group(
    GroupDescription='string',
    GroupName='string',
    Placement={
        'AvailabilityZone': 'string',
        'RegionName': 'string'
    }
)
Parameters:
  • GroupDescription (string) –
  • GroupName (string) –
  • Placement (dict) –
    • AvailabilityZone (string) –
    • RegionName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

create_ssl_certificate(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_ssl_certificate(
    ApproverEmailAddress='string',
    CertAuthority=123,
    CertInfo={
        'LocationName': 'string',
        'OrganizationName': 'string',
        'OrganizationUnitName': 'string',
        'StateName': 'string'
    },
    Count=123,
    Fqdn='string',
    FqdnId='string',
    KeyLength=123,
    ValidityTerm=123
)
Parameters:
  • ApproverEmailAddress (string) –
  • CertAuthority (integer) –
  • CertInfo (dict) –
    • LocationName (string) –
    • OrganizationName (string) –
    • OrganizationUnitName (string) –
    • StateName (string) –
  • Count (integer) –
  • Fqdn (string) –
  • FqdnId (string) –
  • KeyLength (integer) –
  • ValidityTerm (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'ApproverEmailAddress': 123,
    'CertAuthority': 'string',
    'CertState': 'string',
    'Fqdn': 'string',
    'FqdnId': 'string',
    'RequestId': 'string',
    'ValidityTerm': 123
}

Response Structure

  • (dict) –
    • ApproverEmailAddress (integer) –
    • CertAuthority (string) –
    • CertState (string) –
    • Fqdn (string) –
    • FqdnId (string) –
    • RequestId (string) –
    • ValidityTerm (integer) –

create_volume(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_volume(
    AccountingType='string',
    Description='string',
    DiskType='string',
    InstanceId='string',
    Size=123,
    VolumeId='string'
)
Parameters:
  • AccountingType (string) –
  • Description (string) –
  • DiskType (string) –
  • InstanceId (string) –
  • Size (integer) –
  • VolumeId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AccountingType': 'string',
    'AvailabilityZone': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'DiskType': 'string',
    'RequestId': 'string',
    'Size': 'string',
    'SnapshotId': 'string',
    'Status': 'string',
    'VolumeId': 'string'
}

Response Structure

  • (dict) –
    • AccountingType (string) –
    • AvailabilityZone (string) –
    • CreateTime (datetime) –
    • DiskType (string) –
    • RequestId (string) –
    • Size (string) –
    • SnapshotId (string) –
    • Status (string) –
    • VolumeId (string) –

create_vpn_connection(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_vpn_connection(
    Agreement=True|False,
    CustomerGatewayId='string',
    NiftyCustomerGatewayName='string',
    NiftyIPsecConfiguration={
        'EncryptionAlgorithm': 'string',
        'HashAlgorithm': 'string',
        'PreSharedKey': 'string'
    },
    NiftyIpsecConfiguration={
        'InternetKeyExchange': 'string'
    },
    NiftyTunnel={
        'DestinationPort': 'string',
        'Encapsulation': 'string',
        'Mode': 'string',
        'PeerSessionId': 'string',
        'PeerTunnelId': 'string',
        'SessionId': 'string',
        'SourcePort': 'string',
        'TunnelId': 'string',
        'Type': 'string'
    },
    NiftyVpnConnectionDescription='string',
    NiftyVpnConnectionMtu='string',
    NiftyVpnGatewayName='string',
    Type='string',
    VpnGatewayId='string'
)
Parameters:
  • Agreement (boolean) –
  • CustomerGatewayId (string) –
  • NiftyCustomerGatewayName (string) –
  • NiftyIPsecConfiguration (dict) –
    • EncryptionAlgorithm (string) –
    • HashAlgorithm (string) –
    • PreSharedKey (string) –
  • NiftyIpsecConfiguration (dict) –
    • InternetKeyExchange (string) –
  • NiftyTunnel (dict) –
    • DestinationPort (string) –
    • Encapsulation (string) –
    • Mode (string) –
    • PeerSessionId (string) –
    • PeerTunnelId (string) –
    • SessionId (string) –
    • SourcePort (string) –
    • TunnelId (string) –
    • Type (string) –
  • NiftyVpnConnectionDescription (string) –
  • NiftyVpnConnectionMtu (string) –
  • NiftyVpnGatewayName (string) –
  • Type (string) –
  • VpnGatewayId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VpnConnection': {
        'CreatedTime': datetime(2015, 1, 1),
        'CustomerGatewayConfiguration': 'string',
        'CustomerGatewayId': 'string',
        'NiftyCustomerGatewayName': 'string',
        'NiftyIpsecConfiguration': {
            'EncryptionAlgorithm': 'string',
            'HashingAlgorithm': 'string',
            'InternetKeyExchange': 'string',
            'Mtu': 'string',
            'PreSharedKey': 'string'
        },
        'NiftyTunnel': {
            'DestinationPort': 'string',
            'Encapsulation': 'string',
            'Mode': 'string',
            'PeerSessionId': 'string',
            'PeerTunnelId': 'string',
            'SessionId': 'string',
            'SourcePort': 'string',
            'TunnelId': 'string',
            'Type': 'string'
        },
        'NiftyVpnConnectionDescription': 'string',
        'NiftyVpnGatewayName': 'string',
        'Options': {
            'StaticRoutesOnly': True|False
        },
        'Routes': {
            'DestinationCidrBlock': 'string',
            'Source': 'string',
            'State': 'string'
        },
        'State': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string',
        'VgwTelemetry': [
            {
                'AcceptedRouteCount': 123,
                'LastStatusChange': datetime(2015, 1, 1),
                'OutsideIpAddress': 'string',
                'Status': 'string',
                'StatusMessage': 'string'
            },
        ],
        'VpnConnectionId': 'string',
        'VpnGatewayId': 'string'
    }
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • VpnConnection (dict) –
      • CreatedTime (datetime) –
      • CustomerGatewayConfiguration (string) –
      • CustomerGatewayId (string) –
      • NiftyCustomerGatewayName (string) –
      • NiftyIpsecConfiguration (dict) –
        • EncryptionAlgorithm (string) –
        • HashingAlgorithm (string) –
        • InternetKeyExchange (string) –
        • Mtu (string) –
        • PreSharedKey (string) –
      • NiftyTunnel (dict) –
        • DestinationPort (string) –
        • Encapsulation (string) –
        • Mode (string) –
        • PeerSessionId (string) –
        • PeerTunnelId (string) –
        • SessionId (string) –
        • SourcePort (string) –
        • TunnelId (string) –
        • Type (string) –
      • NiftyVpnConnectionDescription (string) –
      • NiftyVpnGatewayName (string) –
      • Options (dict) –
        • StaticRoutesOnly (boolean) –
      • Routes (dict) –
        • DestinationCidrBlock (string) –
        • Source (string) –
        • State (string) –
      • State (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –
      • Type (string) –
      • VgwTelemetry (list) –
        • (dict) –
          • AcceptedRouteCount (integer) –
          • LastStatusChange (datetime) –
          • OutsideIpAddress (string) –
          • Status (string) –
          • StatusMessage (string) –
      • VpnConnectionId (string) –
      • VpnGatewayId (string) –

create_vpn_gateway(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.create_vpn_gateway(
    AccountingType='string',
    NiftyNetwork={
        'IpAddress': 'string',
        'NetworkId': 'string',
        'NetworkName': 'string'
    },
    NiftyRedundancy=True|False,
    NiftyVpnGatewayDescription='string',
    NiftyVpnGatewayName='string',
    NiftyVpnGatewayType='string',
    Placement={
        'AvailabilityZone': 'string',
        'RegionName': 'string'
    },
    SecurityGroup=[
        'string',
    ]
)
Parameters:
  • AccountingType (string) –
  • NiftyNetwork (dict) –
    • IpAddress (string) –
    • NetworkId (string) –
    • NetworkName (string) –
  • NiftyRedundancy (boolean) –
  • NiftyVpnGatewayDescription (string) –
  • NiftyVpnGatewayName (string) –
  • NiftyVpnGatewayType (string) –
  • Placement (dict) –
    • AvailabilityZone (string) –
    • RegionName (string) –
  • SecurityGroup (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VpnGateway': {
        'AccountingType': 'string',
        'Attachments': [
            {
                'State': 'string',
                'VpcId': 'string'
            },
        ],
        'AvailabilityZone': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'GroupSet': [
            {
                'GroupId': 'string'
            },
        ],
        'NetworkInterfaceSet': [
            {
                'Association': {
                    'IpOwnerId': 'string',
                    'PublicDnsName': 'string',
                    'PublicIp': 'string',
                    'PublicIpV6': 'string'
                },
                'Attachment': {
                    'AttachTime': datetime(2015, 1, 1),
                    'AttachmentID': 'string',
                    'DeleteOnTermination': True|False,
                    'DeviceIndex': 123,
                    'Status': 'string'
                },
                'CidrBlock': 'string',
                'Descriprion': 'string',
                'Description': 'string',
                'DeviceIndex': 123,
                'Dhcp': True|False,
                'DhcpOptionsId': 'string',
                'GroupSet': [
                    {
                        'GroupId': 'string'
                    },
                ],
                'IpAddress': 'string',
                'MacAddress': 'string',
                'NetworkId': 'string',
                'NetworkInterfaceId': 'string',
                'NetworkName': 'string',
                'NiftyNetworkId': 'string',
                'NiftyNetworkName': 'string',
                'OwnerId': 'string',
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddressV6': 'string',
                'PrivateIpAddressesSet': [
                    {
                        'Association': {
                            'IpOwnerId': 'string',
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'PublicIpV6': 'string'
                        },
                        'Primary': True|False,
                        'PrivateDnsName': 'string',
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SourceDestCheck': 'string',
                'Status': 'string',
                'SubnetId': 'string',
                'VpcId': 'string'
            },
        ],
        'NextMonthAccountingType': 'string',
        'NiftyRedundancy': True|False,
        'NiftyVpnGatewayDescription': 'string',
        'NiftyVpnGatewayName': 'string',
        'NiftyVpnGatewayType': 'string',
        'State': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string',
        'VpnGatewayId': 'string'
    }
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • VpnGateway (dict) –
      • AccountingType (string) –
      • Attachments (list) –
        • (dict) –
          • State (string) –
          • VpcId (string) –
      • AvailabilityZone (string) –
      • CreatedTime (datetime) –
      • GroupSet (list) –
        • (dict) –
          • GroupId (string) –
      • NetworkInterfaceSet (list) –
        • (dict) –
          • Association (dict) –
            • IpOwnerId (string) –
            • PublicDnsName (string) –
            • PublicIp (string) –
            • PublicIpV6 (string) –
          • Attachment (dict) –
            • AttachTime (datetime) –
            • AttachmentID (string) –
            • DeleteOnTermination (boolean) –
            • DeviceIndex (integer) –
            • Status (string) –
          • CidrBlock (string) –
          • Descriprion (string) –
          • Description (string) –
          • DeviceIndex (integer) –
          • Dhcp (boolean) –
          • DhcpOptionsId (string) –
          • GroupSet (list) –
            • (dict) –
              • GroupId (string) –
          • IpAddress (string) –
          • MacAddress (string) –
          • NetworkId (string) –
          • NetworkInterfaceId (string) –
          • NetworkName (string) –
          • NiftyNetworkId (string) –
          • NiftyNetworkName (string) –
          • OwnerId (string) –
          • PrivateDnsName (string) –
          • PrivateIpAddress (string) –
          • PrivateIpAddressV6 (string) –
          • PrivateIpAddressesSet (list) –
            • (dict) –
              • Association (dict) –
                • IpOwnerId (string) –
                • PublicDnsName (string) –
                • PublicIp (string) –
                • PublicIpV6 (string) –
              • Primary (boolean) –
              • PrivateDnsName (string) –
              • PrivateIpAddress (string) –
          • SourceDestCheck (string) –
          • Status (string) –
          • SubnetId (string) –
          • VpcId (string) –
      • NextMonthAccountingType (string) –
      • NiftyRedundancy (boolean) –
      • NiftyVpnGatewayDescription (string) –
      • NiftyVpnGatewayName (string) –
      • NiftyVpnGatewayType (string) –
      • State (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –
      • Type (string) –
      • VpnGatewayId (string) –

delete_customer_gateway(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_customer_gateway(
    CustomerGatewayId='string',
    NiftyCustomerGatewayName='string'
)
Parameters:
  • CustomerGatewayId (string) –
  • NiftyCustomerGatewayName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

delete_dhcp_options(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_dhcp_options(
    DhcpOptionsId='string'
)
Parameters:DhcpOptionsId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
delete_image(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_image(
    ImageId='string'
)
Parameters:ImageId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • RequestId (string) –
delete_key_pair(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_key_pair(
    KeyName='string'
)
Parameters:KeyName (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
delete_load_balancer(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_load_balancer(
    InstancePort=123,
    LoadBalancerName='string',
    LoadBalancerPort=123
)
Parameters:
  • InstancePort (integer) –
  • LoadBalancerName (string) –
  • LoadBalancerPort (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

delete_route(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_route(
    DestinationCidrBlock='string',
    RouteTableId='string'
)
Parameters:
  • DestinationCidrBlock (string) –
  • RouteTableId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

delete_route_table(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_route_table(
    RouteTableId='string'
)
Parameters:RouteTableId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
delete_security_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_security_group(
    GroupName='string'
)
Parameters:GroupName (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
delete_ssl_certificate(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_ssl_certificate(
    FqdnId='string'
)
Parameters:FqdnId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
delete_volume(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_volume(
    VolumeId='string'
)
Parameters:VolumeId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
delete_vpn_connection(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_vpn_connection(
    Agreement=True|False,
    VpnConnectionId='string'
)
Parameters:
  • Agreement (boolean) –
  • VpnConnectionId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

delete_vpn_gateway(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.delete_vpn_gateway(
    NiftyVpnGatewayName='string',
    VpnGatewayId='string'
)
Parameters:
  • NiftyVpnGatewayName (string) –
  • VpnGatewayId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

deregister_instances_from_load_balancer(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.deregister_instances_from_load_balancer(
    InstancePort=123,
    Instances=[
        {
            'InstanceId': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    LoadBalancerName='string',
    LoadBalancerPort=123
)
Parameters:
  • InstancePort (integer) –
  • Instances (list) –
    • (dict) –
      • InstanceId (string) –
      • InstanceUniqueId (string) –
  • LoadBalancerName (string) –
  • LoadBalancerPort (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'DeregisterInstancesFromLoadBalancerResult': {'... recursive ...'},
    'Instances': [
        {
            'InstanceId': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • DeregisterInstancesFromLoadBalancerResult (dict) –
    • Instances (list) –
      • (dict) –
        • InstanceId (string) –
        • InstanceUniqueId (string) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

deregister_instances_from_security_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.deregister_instances_from_security_group(
    GroupName='string',
    InstanceId=[
        'string',
    ]
)
Parameters:
  • GroupName (string) –
  • InstanceId (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'InstancesSet': [
        {
            'AccountingType': 'string',
            'Admin': 'string',
            'AmiLaunchIndex': 'string',
            'Architecture': 'string',
            'Autoscaling': {
                'AutoScalingGroupName': 'string',
                'ExpireTime': datetime(2015, 1, 1)
            },
            'BlockDeviceMapping': [
                {
                    'DeviceName': 'string',
                    'Ebs': {
                        'AttachTime': datetime(2015, 1, 1),
                        'DeleteOnTermination': True|False,
                        'SnapshotId': 'string',
                        'Status': 'string',
                        'VolumeId': 'string',
                        'VolumeSize': 123
                    },
                    'NoDevice': 'string',
                    'VirtualName': 'string'
                },
            ],
            'CopyInfo': 'string',
            'CurrentState': {
                'Code': 123,
                'Name': 'string'
            },
            'Description': 'string',
            'DeviceIndex': 123,
            'DnsName': 'string',
            'ExpireTime': datetime(2015, 1, 1),
            'HotAdd': 'string',
            'ImageId': 'string',
            'ImageName': 'string',
            'InstanceId': 'string',
            'InstanceLifecycle': 'string',
            'InstanceState': {
                'Code': 123,
                'Name': 'string'
            },
            'InstanceType': 'string',
            'InstanceUniqueId': 'string',
            'IpAddress': 'string',
            'IpAddressV6': 'string',
            'IpType': 'string',
            'KernelId': 'string',
            'KeyName': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'Loadbalancing': [
                {
                    'InstancePort': 123,
                    'LoadBalancerName': 'string',
                    'LoadBalancerPort': 123,
                    'State': 'string'
                },
            ],
            'Monitoring': {
                'State': 'string'
            },
            'NetworkInterfaceSet': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'PublicIpV6': 'string'
                    },
                    'Attachment': {
                        'AttachTime': datetime(2015, 1, 1),
                        'AttachmentID': 'string',
                        'DeleteOnTermination': True|False,
                        'DeviceIndex': 123,
                        'Status': 'string'
                    },
                    'CidrBlock': 'string',
                    'Descriprion': 'string',
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'Dhcp': True|False,
                    'DhcpOptionsId': 'string',
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'MacAddress': 'string',
                    'NetworkId': 'string',
                    'NetworkInterfaceId': 'string',
                    'NetworkName': 'string',
                    'NiftyNetworkId': 'string',
                    'NiftyNetworkName': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'PrivateIpAddressesSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Primary': True|False,
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SourceDestCheck': 'string',
                    'Status': 'string',
                    'SubnetId': 'string',
                    'VpcId': 'string'
                },
            ],
            'NextMonthAccountingType': 'string',
            'NiftyElasticLoadBalancing': [
                {
                    'ElasticLoadBalancerId': 'string',
                    'ElasticLoadBalancerName': 'string',
                    'ElasticLoadBalancerPort': 123,
                    'InstancePort': 123,
                    'Protocol': 'string'
                },
            ],
            'NiftyPrivateIpType': 'string',
            'NiftyPrivateNetworkType': 'string',
            'NiftySnapshotting': [
                {
                    'State': 'string'
                },
            ],
            'Placement': {
                'AvailabilityZone': 'string',
                'RegionName': 'string'
            },
            'Platform': 'string',
            'PreviousState': {
                'Code': 123,
                'Name': 'string'
            },
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddressV6': 'string',
            'ProductCodes': [
                {
                    'ProductCode': 'string'
                },
            ],
            'RamdiskId': 'string',
            'Reason': 'string',
            'RegionName': 'string',
            'RootDeviceName': 'string',
            'RootDeviceType': 'string',
            'SpotInstanceRequestId': 'string',
            'StateReason': {
                'Code': 123,
                'Message': 'string'
            },
            'SubnetId': 'string',
            'Tenancy': 'string',
            'VpcId': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • InstancesSet (list) –
      • (dict) –
        • AccountingType (string) –
        • Admin (string) –
        • AmiLaunchIndex (string) –
        • Architecture (string) –
        • Autoscaling (dict) –
          • AutoScalingGroupName (string) –
          • ExpireTime (datetime) –
        • BlockDeviceMapping (list) –
          • (dict) –
            • DeviceName (string) –
            • Ebs (dict) –
              • AttachTime (datetime) –
              • DeleteOnTermination (boolean) –
              • SnapshotId (string) –
              • Status (string) –
              • VolumeId (string) –
              • VolumeSize (integer) –
            • NoDevice (string) –
            • VirtualName (string) –
        • CopyInfo (string) –
        • CurrentState (dict) –
          • Code (integer) –
          • Name (string) –
        • Description (string) –
        • DeviceIndex (integer) –
        • DnsName (string) –
        • ExpireTime (datetime) –
        • HotAdd (string) –
        • ImageId (string) –
        • ImageName (string) –
        • InstanceId (string) –
        • InstanceLifecycle (string) –
        • InstanceState (dict) –
          • Code (integer) –
          • Name (string) –
        • InstanceType (string) –
        • InstanceUniqueId (string) –
        • IpAddress (string) –
        • IpAddressV6 (string) –
        • IpType (string) –
        • KernelId (string) –
        • KeyName (string) –
        • LaunchTime (datetime) –
        • Loadbalancing (list) –
          • (dict) –
            • InstancePort (integer) –
            • LoadBalancerName (string) –
            • LoadBalancerPort (integer) –
            • State (string) –
        • Monitoring (dict) –
          • State (string) –
        • NetworkInterfaceSet (list) –
          • (dict) –
            • Association (dict) –
              • IpOwnerId (string) –
              • PublicDnsName (string) –
              • PublicIp (string) –
              • PublicIpV6 (string) –
            • Attachment (dict) –
              • AttachTime (datetime) –
              • AttachmentID (string) –
              • DeleteOnTermination (boolean) –
              • DeviceIndex (integer) –
              • Status (string) –
            • CidrBlock (string) –
            • Descriprion (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • Dhcp (boolean) –
            • DhcpOptionsId (string) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • MacAddress (string) –
            • NetworkId (string) –
            • NetworkInterfaceId (string) –
            • NetworkName (string) –
            • NiftyNetworkId (string) –
            • NiftyNetworkName (string) –
            • OwnerId (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • PrivateIpAddressesSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Primary (boolean) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
            • SourceDestCheck (string) –
            • Status (string) –
            • SubnetId (string) –
            • VpcId (string) –
        • NextMonthAccountingType (string) –
        • NiftyElasticLoadBalancing (list) –
          • (dict) –
            • ElasticLoadBalancerId (string) –
            • ElasticLoadBalancerName (string) –
            • ElasticLoadBalancerPort (integer) –
            • InstancePort (integer) –
            • Protocol (string) –
        • NiftyPrivateIpType (string) –
        • NiftyPrivateNetworkType (string) –
        • NiftySnapshotting (list) –
          • (dict) –
            • State (string) –
        • Placement (dict) –
          • AvailabilityZone (string) –
          • RegionName (string) –
        • Platform (string) –
        • PreviousState (dict) –
          • Code (integer) –
          • Name (string) –
        • PrivateDnsName (string) –
        • PrivateIpAddress (string) –
        • PrivateIpAddressV6 (string) –
        • ProductCodes (list) –
          • (dict) –
            • ProductCode (string) –
        • RamdiskId (string) –
        • Reason (string) –
        • RegionName (string) –
        • RootDeviceName (string) –
        • RootDeviceType (string) –
        • SpotInstanceRequestId (string) –
        • StateReason (dict) –
          • Code (integer) –
          • Message (string) –
        • SubnetId (string) –
        • Tenancy (string) –
        • VpcId (string) –
    • RequestId (string) –

describe_addresses(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_addresses(
    PrivateIpAddress=[
        'string',
    ],
    PublicIp=[
        'string',
    ]
)
Parameters:
  • PrivateIpAddress (list) –
    • (string) –
  • PublicIp (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AddressesSet': [
        {
            'AllocationId': 'string',
            'AssociationId': 'string',
            'AvailabilityZone': 'string',
            'Description': 'string',
            'Domain': 'string',
            'InstanceId': 'string',
            'InstanceUniqueId': 'string',
            'NetworkInterfaceId': 'string',
            'NetworkInterfaceOwnerId': 'string',
            'PrivateIpAddress': 'string',
            'PublicIp': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • AddressesSet (list) –
      • (dict) –
        • AllocationId (string) –
        • AssociationId (string) –
        • AvailabilityZone (string) –
        • Description (string) –
        • Domain (string) –
        • InstanceId (string) –
        • InstanceUniqueId (string) –
        • NetworkInterfaceId (string) –
        • NetworkInterfaceOwnerId (string) –
        • PrivateIpAddress (string) –
        • PublicIp (string) –
    • RequestId (string) –

describe_associated_users(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_associated_users(
    FunctionName='string'
)
Parameters:FunctionName (string) –
Return type:dict
Returns:Response Syntax
{
    'DescribeAssociatedUsersResult': {'... recursive ...'},
    'ResponseMetadata': {
        'RequestId': 'string'
    },
    'Users': [
        {
            'UserId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • DescribeAssociatedUsersResult (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –
    • Users (list) –
      • (dict) –
        • UserId (string) –
describe_availability_zones(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_availability_zones(
    ZoneName=[
        'string',
    ]
)
Parameters:ZoneName (list) –
  • (string) –
Return type:dict
Returns:Response Syntax
{
    'AvailabilityZoneInfo': [
        {
            'MessageSet': [
                {
                    'Message': 'string'
                },
            ],
            'RegionName': 'string',
            'ZoneName': 'string',
            'ZoneState': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • AvailabilityZoneInfo (list) –
      • (dict) –
        • MessageSet (list) –
          • (dict) –
            • Message (string) –
        • RegionName (string) –
        • ZoneName (string) –
        • ZoneState (string) –
    • RequestId (string) –
describe_customer_gateways(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_customer_gateways(
    CustomerGatewayId=[
        'string',
    ],
    Filter=[
        {
            'Name': 'string',
            'RequestValue': [
                'string',
            ]
        },
    ],
    NiftyCustomerGatewayName=[
        'string',
    ]
)
Parameters:
  • CustomerGatewayId (list) –
    • (string) –
  • Filter (list) –
    • (dict) –
      • Name (string) –
      • RequestValue (list) –
        • (string) –
  • NiftyCustomerGatewayName (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'CustomerGatewaySet': [
        {
            'BgpAsn': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'CustomerGatewayId': 'string',
            'IpAddress': 'string',
            'NiftyCustomerGatewayDescription': 'string',
            'NiftyCustomerGatewayName': 'string',
            'NiftyLanSideCidrBlock': 'string',
            'NiftyLanSideIpAddress': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • CustomerGatewaySet (list) –
      • (dict) –
        • BgpAsn (string) –
        • CreatedTime (datetime) –
        • CustomerGatewayId (string) –
        • IpAddress (string) –
        • NiftyCustomerGatewayDescription (string) –
        • NiftyCustomerGatewayName (string) –
        • NiftyLanSideCidrBlock (string) –
        • NiftyLanSideIpAddress (string) –
        • State (string) –
        • TagSet (list) –
          • (dict) –
            • Key (string) –
            • Value (string) –
        • Type (string) –
    • RequestId (string) –

describe_dhcp_options(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_dhcp_options(
    DhcpOptionsId=[
        'string',
    ],
    Filter=[
        {
            'Name': 'string',
            'RequestValue': [
                'string',
            ]
        },
    ]
)
Parameters:
  • DhcpOptionsId (list) –
    • (string) –
  • Filter (list) –
    • (dict) –
      • Name (string) –
      • RequestValue (list) –
        • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DhcpOptionsSet': {
        'DhcpConfigurationSet': [
            {
                'Key': 'string',
                'ValueSet': [
                    {
                        'Value': 'string'
                    },
                ]
            },
        ],
        'DhcpOptionsId': 'string'
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • DhcpOptionsSet (dict) –
      • DhcpConfigurationSet (list) –
        • (dict) –
          • Key (string) –
          • ValueSet (list) –
            • (dict) –
              • Value (string) –
      • DhcpOptionsId (string) –
    • RequestId (string) –

describe_images(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_images(
    ImageId=[
        'string',
    ],
    ImageName=[
        'string',
    ],
    Owner=[
        'string',
    ]
)
Parameters:
  • ImageId (list) –
    • (string) –
  • ImageName (list) –
    • (string) –
  • Owner (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'ImagesSet': [
        {
            'Architecture': 'string',
            'BlockDeviceMapping': [
                {
                    'DeviceName': 'string',
                    'Ebs': {
                        'AttachTime': datetime(2015, 1, 1),
                        'DeleteOnTermination': True|False,
                        'SnapshotId': 'string',
                        'Status': 'string',
                        'VolumeId': 'string',
                        'VolumeSize': 123
                    },
                    'NoDevice': 'string',
                    'VirtualName': 'string'
                },
            ],
            'Description': 'string',
            'DetailDescription': 'string',
            'ImageId': 'string',
            'ImageLocation': 'string',
            'ImageOwnerAlias': 'string',
            'ImageOwnerId': 'string',
            'ImageState': 'string',
            'ImageType': 'string',
            'IsPublic': True|False,
            'KernelId': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'Name': 'string',
            'NiftyContactUrl': 'string',
            'NiftyDistributionIds': [
                {
                    'DistributionId': 'string'
                },
            ],
            'NiftyImageSize': 123,
            'NiftyIsAllowedDistribution': True|False,
            'Placement': {
                'AvailabilityZone': 'string',
                'RegionName': 'string'
            },
            'Platform': 'string',
            'ProductCodes': [
                {
                    'ProductCode': 'string'
                },
            ],
            'RamdiskId': 'string',
            'Redistributable': True|False,
            'RootDeviceName': 'string',
            'RootDeviceType': 'string',
            'StateReason': {
                'Code': 123,
                'Message': 'string'
            }
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • ImagesSet (list) –
      • (dict) –
        • Architecture (string) –
        • BlockDeviceMapping (list) –
          • (dict) –
            • DeviceName (string) –
            • Ebs (dict) –
              • AttachTime (datetime) –
              • DeleteOnTermination (boolean) –
              • SnapshotId (string) –
              • Status (string) –
              • VolumeId (string) –
              • VolumeSize (integer) –
            • NoDevice (string) –
            • VirtualName (string) –
        • Description (string) –
        • DetailDescription (string) –
        • ImageId (string) –
        • ImageLocation (string) –
        • ImageOwnerAlias (string) –
        • ImageOwnerId (string) –
        • ImageState (string) –
        • ImageType (string) –
        • IsPublic (boolean) –
        • KernelId (string) –
        • LaunchTime (datetime) –
        • Name (string) –
        • NiftyContactUrl (string) –
        • NiftyDistributionIds (list) –
          • (dict) –
            • DistributionId (string) –
        • NiftyImageSize (integer) –
        • NiftyIsAllowedDistribution (boolean) –
        • Placement (dict) –
          • AvailabilityZone (string) –
          • RegionName (string) –
        • Platform (string) –
        • ProductCodes (list) –
          • (dict) –
            • ProductCode (string) –
        • RamdiskId (string) –
        • Redistributable (boolean) –
        • RootDeviceName (string) –
        • RootDeviceType (string) –
        • StateReason (dict) –
          • Code (integer) –
          • Message (string) –
    • RequestId (string) –

describe_instance_attribute(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_instance_attribute(
    Attribute='string',
    InstanceId='string'
)
Parameters:
  • Attribute (string) –
  • InstanceId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AccountingType': {
        'Value': 'string'
    },
    'Autoscaling': {
        'AutoScalingGroupName': 'string',
        'ExpireTime': datetime(2015, 1, 1)
    },
    'BlockDeviceMapping': [
        {
            'DeviceName': 'string',
            'Ebs': {
                'AttachTime': datetime(2015, 1, 1),
                'DeleteOnTermination': True|False,
                'SnapshotId': 'string',
                'Status': 'string',
                'VolumeId': 'string',
                'VolumeSize': 123
            },
            'NoDevice': 'string',
            'VirtualName': 'string'
        },
    ],
    'CopyInfo': {
        'InstanceCopy': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'Value': 'string'
    },
    'DescriptionValue': {
        'Value': 'string'
    },
    'DisableApiTermination': {
        'Value': 'string'
    },
    'GroupIdValue': {
        'Value': 'string'
    },
    'InstanceId': 'string',
    'InstanceInitiatedShutdownBehavior': {
        'Value': 'string'
    },
    'InstanceType': {
        'Value': 'string'
    },
    'InstanceUniqueId': 'string',
    'IpType': {
        'Value': 'string'
    },
    'Kernel': {
        'Value': 'string'
    },
    'Loadbalancing': [
        {
            'InstancePort': 123,
            'LoadBalancerName': 'string',
            'LoadBalancerPort': 123,
            'State': 'string'
        },
    ],
    'NetworkInterfaceSet': [
        {
            'Association': {
                'IpOwnerId': 'string',
                'PublicDnsName': 'string',
                'PublicIp': 'string',
                'PublicIpV6': 'string'
            },
            'Attachment': {
                'AttachTime': datetime(2015, 1, 1),
                'AttachmentID': 'string',
                'DeleteOnTermination': True|False,
                'DeviceIndex': 123,
                'Status': 'string'
            },
            'CidrBlock': 'string',
            'Descriprion': 'string',
            'Description': 'string',
            'DeviceIndex': 123,
            'Dhcp': True|False,
            'DhcpOptionsId': 'string',
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'IpAddress': 'string',
            'MacAddress': 'string',
            'NetworkId': 'string',
            'NetworkInterfaceId': 'string',
            'NetworkName': 'string',
            'NiftyNetworkId': 'string',
            'NiftyNetworkName': 'string',
            'OwnerId': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddressV6': 'string',
            'PrivateIpAddressesSet': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'PublicIpV6': 'string'
                    },
                    'Primary': True|False,
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string'
                },
            ],
            'SourceDestCheck': 'string',
            'Status': 'string',
            'SubnetId': 'string',
            'VpcId': 'string'
        },
    ],
    'NextMonthAccountingType': {
        'Value': 'string'
    },
    'NiftyElasticLoadBalancing': [
        {
            'ElasticLoadBalancerId': 'string',
            'ElasticLoadBalancerName': 'string',
            'ElasticLoadBalancerPort': 123,
            'InstancePort': 123,
            'Protocol': 'string'
        },
    ],
    'NiftyPrivateIpType': {
        'Value': 'string'
    },
    'Ramdisk': {
        'Value': 'string'
    },
    'RequestId': 'string',
    'RootDeviceName': {
        'Value': 'string'
    },
    'UserData': {
        'Value': 'string'
    }
}

Response Structure

  • (dict) –
    • AccountingType (dict) –
      • Value (string) –
    • Autoscaling (dict) –
      • AutoScalingGroupName (string) –
      • ExpireTime (datetime) –
    • BlockDeviceMapping (list) –
      • (dict) –
        • DeviceName (string) –
        • Ebs (dict) –
          • AttachTime (datetime) –
          • DeleteOnTermination (boolean) –
          • SnapshotId (string) –
          • Status (string) –
          • VolumeId (string) –
          • VolumeSize (integer) –
        • NoDevice (string) –
        • VirtualName (string) –
    • CopyInfo (dict) –
      • InstanceCopy (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • Value (string) –
    • DescriptionValue (dict) –
      • Value (string) –
    • DisableApiTermination (dict) –
      • Value (string) –
    • GroupIdValue (dict) –
      • Value (string) –
    • InstanceId (string) –
    • InstanceInitiatedShutdownBehavior (dict) –
      • Value (string) –
    • InstanceType (dict) –
      • Value (string) –
    • InstanceUniqueId (string) –
    • IpType (dict) –
      • Value (string) –
    • Kernel (dict) –
      • Value (string) –
    • Loadbalancing (list) –
      • (dict) –
        • InstancePort (integer) –
        • LoadBalancerName (string) –
        • LoadBalancerPort (integer) –
        • State (string) –
    • NetworkInterfaceSet (list) –
      • (dict) –
        • Association (dict) –
          • IpOwnerId (string) –
          • PublicDnsName (string) –
          • PublicIp (string) –
          • PublicIpV6 (string) –
        • Attachment (dict) –
          • AttachTime (datetime) –
          • AttachmentID (string) –
          • DeleteOnTermination (boolean) –
          • DeviceIndex (integer) –
          • Status (string) –
        • CidrBlock (string) –
        • Descriprion (string) –
        • Description (string) –
        • DeviceIndex (integer) –
        • Dhcp (boolean) –
        • DhcpOptionsId (string) –
        • GroupSet (list) –
          • (dict) –
            • GroupId (string) –
        • IpAddress (string) –
        • MacAddress (string) –
        • NetworkId (string) –
        • NetworkInterfaceId (string) –
        • NetworkName (string) –
        • NiftyNetworkId (string) –
        • NiftyNetworkName (string) –
        • OwnerId (string) –
        • PrivateDnsName (string) –
        • PrivateIpAddress (string) –
        • PrivateIpAddressV6 (string) –
        • PrivateIpAddressesSet (list) –
          • (dict) –
            • Association (dict) –
              • IpOwnerId (string) –
              • PublicDnsName (string) –
              • PublicIp (string) –
              • PublicIpV6 (string) –
            • Primary (boolean) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
        • SourceDestCheck (string) –
        • Status (string) –
        • SubnetId (string) –
        • VpcId (string) –
    • NextMonthAccountingType (dict) –
      • Value (string) –
    • NiftyElasticLoadBalancing (list) –
      • (dict) –
        • ElasticLoadBalancerId (string) –
        • ElasticLoadBalancerName (string) –
        • ElasticLoadBalancerPort (integer) –
        • InstancePort (integer) –
        • Protocol (string) –
    • NiftyPrivateIpType (dict) –
      • Value (string) –
    • Ramdisk (dict) –
      • Value (string) –
    • RequestId (string) –
    • RootDeviceName (dict) –
      • Value (string) –
    • UserData (dict) –
      • Value (string) –

describe_instance_health(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_instance_health(
    InstancePort=123,
    Instances=[
        {
            'InstanceId': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    LoadBalancerName='string',
    LoadBalancerPort=123
)
Parameters:
  • InstancePort (integer) –
  • Instances (list) –
    • (dict) –
      • InstanceId (string) –
      • InstanceUniqueId (string) –
  • LoadBalancerName (string) –
  • LoadBalancerPort (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'DescribeInstanceHealthResult': {'... recursive ...'},
    'InstanceStates': [
        {
            'Description': 'string',
            'InstanceId': 'string',
            'InstanceUniqueId': 'string',
            'ReasonCode': 'string',
            'State': 'string'
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • DescribeInstanceHealthResult (dict) –
    • InstanceStates (list) –
      • (dict) –
        • Description (string) –
        • InstanceId (string) –
        • InstanceUniqueId (string) –
        • ReasonCode (string) –
        • State (string) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

describe_instances(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_instances(
    InstanceId=[
        'string',
    ],
    Tenancy=[
        'string',
    ]
)
Parameters:
  • InstanceId (list) –
    • (string) –
  • Tenancy (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'ReservationSet': [
        {
            'AlarmCondition': 'string',
            'AlarmDateHistorySet': [
                {
                    'AlarmEventHistorySet': [
                        {
                            'AlarmEvent': 'string',
                            'AlarmEventDatetime': datetime(2015, 1, 1)
                        },
                    ],
                    'Date': 'string'
                },
            ],
            'AlarmRulesActivitiesSet': [
                {
                    'AlarmRulesActivitiesDateSet': [
                        {
                            'AlarmRulesActivitiesEventSet': [
                                {
                                    'AlarmRulesActivitiesEvent': 'string',
                                    'AlarmRulesActivitiesEventDatetime': datetime(2015, 1, 1),
                                    'ResourceName': 'string',
                                    'Value': 'string'
                                },
                            ],
                            'Date': 'string'
                        },
                    ],
                    'DataType': 'string'
                },
            ],
            'AlarmState': 'string',
            'AlarmTargetsSet': [
                {
                    'ResourceName': 'string'
                },
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'EmailAddressSet': [
                {
                    'EmailAddress': 'string'
                },
            ],
            'FunctionName': 'string',
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'InstancesSet': [
                {
                    'AccountingType': 'string',
                    'Admin': 'string',
                    'AmiLaunchIndex': 'string',
                    'Architecture': 'string',
                    'Autoscaling': {
                        'AutoScalingGroupName': 'string',
                        'ExpireTime': datetime(2015, 1, 1)
                    },
                    'BlockDeviceMapping': [
                        {
                            'DeviceName': 'string',
                            'Ebs': {
                                'AttachTime': datetime(2015, 1, 1),
                                'DeleteOnTermination': True|False,
                                'SnapshotId': 'string',
                                'Status': 'string',
                                'VolumeId': 'string',
                                'VolumeSize': 123
                            },
                            'NoDevice': 'string',
                            'VirtualName': 'string'
                        },
                    ],
                    'CopyInfo': 'string',
                    'CurrentState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'DnsName': 'string',
                    'ExpireTime': datetime(2015, 1, 1),
                    'HotAdd': 'string',
                    'ImageId': 'string',
                    'ImageName': 'string',
                    'InstanceId': 'string',
                    'InstanceLifecycle': 'string',
                    'InstanceState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'InstanceType': 'string',
                    'InstanceUniqueId': 'string',
                    'IpAddress': 'string',
                    'IpAddressV6': 'string',
                    'IpType': 'string',
                    'KernelId': 'string',
                    'KeyName': 'string',
                    'LaunchTime': datetime(2015, 1, 1),
                    'Loadbalancing': [
                        {
                            'InstancePort': 123,
                            'LoadBalancerName': 'string',
                            'LoadBalancerPort': 123,
                            'State': 'string'
                        },
                    ],
                    'Monitoring': {
                        'State': 'string'
                    },
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NextMonthAccountingType': 'string',
                    'NiftyElasticLoadBalancing': [
                        {
                            'ElasticLoadBalancerId': 'string',
                            'ElasticLoadBalancerName': 'string',
                            'ElasticLoadBalancerPort': 123,
                            'InstancePort': 123,
                            'Protocol': 'string'
                        },
                    ],
                    'NiftyPrivateIpType': 'string',
                    'NiftyPrivateNetworkType': 'string',
                    'NiftySnapshotting': [
                        {
                            'State': 'string'
                        },
                    ],
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'RegionName': 'string'
                    },
                    'Platform': 'string',
                    'PreviousState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'ProductCodes': [
                        {
                            'ProductCode': 'string'
                        },
                    ],
                    'RamdiskId': 'string',
                    'Reason': 'string',
                    'RegionName': 'string',
                    'RootDeviceName': 'string',
                    'RootDeviceType': 'string',
                    'SpotInstanceRequestId': 'string',
                    'StateReason': {
                        'Code': 123,
                        'Message': 'string'
                    },
                    'SubnetId': 'string',
                    'Tenancy': 'string',
                    'VpcId': 'string'
                },
            ],
            'OwnerId': 'string',
            'ReservationId': 'string',
            'RuleName': 'string',
            'RuleSet': [
                {
                    'BreachDuration': 123,
                    'DataType': 'string',
                    'Threshold': 123.0,
                    'UpperLowerCondition': 'string'
                },
            ],
            'Zone': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • ReservationSet (list) –
      • (dict) –
        • AlarmCondition (string) –
        • AlarmDateHistorySet (list) –
          • (dict) –
            • AlarmEventHistorySet (list) –
              • (dict) –
                • AlarmEvent (string) –
                • AlarmEventDatetime (datetime) –
            • Date (string) –
        • AlarmRulesActivitiesSet (list) –
          • (dict) –
            • AlarmRulesActivitiesDateSet (list) –
              • (dict) –
                • AlarmRulesActivitiesEventSet (list) –
                  • (dict) –
                    • AlarmRulesActivitiesEvent (string) –
                    • AlarmRulesActivitiesEventDatetime (datetime) –
                    • ResourceName (string) –
                    • Value (string) –
                • Date (string) –
            • DataType (string) –
        • AlarmState (string) –
        • AlarmTargetsSet (list) –
          • (dict) –
            • ResourceName (string) –
        • CreatedTime (datetime) –
        • Description (string) –
        • EmailAddressSet (list) –
          • (dict) –
            • EmailAddress (string) –
        • FunctionName (string) –
        • GroupSet (list) –
          • (dict) –
            • GroupId (string) –
        • InstancesSet (list) –
          • (dict) –
            • AccountingType (string) –
            • Admin (string) –
            • AmiLaunchIndex (string) –
            • Architecture (string) –
            • Autoscaling (dict) –
              • AutoScalingGroupName (string) –
              • ExpireTime (datetime) –
            • BlockDeviceMapping (list) –
              • (dict) –
                • DeviceName (string) –
                • Ebs (dict) –
                  • AttachTime (datetime) –
                  • DeleteOnTermination (boolean) –
                  • SnapshotId (string) –
                  • Status (string) –
                  • VolumeId (string) –
                  • VolumeSize (integer) –
                • NoDevice (string) –
                • VirtualName (string) –
            • CopyInfo (string) –
            • CurrentState (dict) –
              • Code (integer) –
              • Name (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • DnsName (string) –
            • ExpireTime (datetime) –
            • HotAdd (string) –
            • ImageId (string) –
            • ImageName (string) –
            • InstanceId (string) –
            • InstanceLifecycle (string) –
            • InstanceState (dict) –
              • Code (integer) –
              • Name (string) –
            • InstanceType (string) –
            • InstanceUniqueId (string) –
            • IpAddress (string) –
            • IpAddressV6 (string) –
            • IpType (string) –
            • KernelId (string) –
            • KeyName (string) –
            • LaunchTime (datetime) –
            • Loadbalancing (list) –
              • (dict) –
                • InstancePort (integer) –
                • LoadBalancerName (string) –
                • LoadBalancerPort (integer) –
                • State (string) –
            • Monitoring (dict) –
              • State (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NextMonthAccountingType (string) –
            • NiftyElasticLoadBalancing (list) –
              • (dict) –
                • ElasticLoadBalancerId (string) –
                • ElasticLoadBalancerName (string) –
                • ElasticLoadBalancerPort (integer) –
                • InstancePort (integer) –
                • Protocol (string) –
            • NiftyPrivateIpType (string) –
            • NiftyPrivateNetworkType (string) –
            • NiftySnapshotting (list) –
              • (dict) –
                • State (string) –
            • Placement (dict) –
              • AvailabilityZone (string) –
              • RegionName (string) –
            • Platform (string) –
            • PreviousState (dict) –
              • Code (integer) –
              • Name (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • ProductCodes (list) –
              • (dict) –
                • ProductCode (string) –
            • RamdiskId (string) –
            • Reason (string) –
            • RegionName (string) –
            • RootDeviceName (string) –
            • RootDeviceType (string) –
            • SpotInstanceRequestId (string) –
            • StateReason (dict) –
              • Code (integer) –
              • Message (string) –
            • SubnetId (string) –
            • Tenancy (string) –
            • VpcId (string) –
        • OwnerId (string) –
        • ReservationId (string) –
        • RuleName (string) –
        • RuleSet (list) –
          • (dict) –
            • BreachDuration (integer) –
            • DataType (string) –
            • Threshold (float) –
            • UpperLowerCondition (string) –
        • Zone (string) –

describe_key_pairs(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_key_pairs(
    KeyName=[
        'string',
    ]
)
Parameters:KeyName (list) –
  • (string) –
Return type:dict
Returns:Response Syntax
{
    'KeySet': [
        {
            'Description': 'string',
            'InstancesSet': [
                {
                    'AccountingType': 'string',
                    'Admin': 'string',
                    'AmiLaunchIndex': 'string',
                    'Architecture': 'string',
                    'Autoscaling': {
                        'AutoScalingGroupName': 'string',
                        'ExpireTime': datetime(2015, 1, 1)
                    },
                    'BlockDeviceMapping': [
                        {
                            'DeviceName': 'string',
                            'Ebs': {
                                'AttachTime': datetime(2015, 1, 1),
                                'DeleteOnTermination': True|False,
                                'SnapshotId': 'string',
                                'Status': 'string',
                                'VolumeId': 'string',
                                'VolumeSize': 123
                            },
                            'NoDevice': 'string',
                            'VirtualName': 'string'
                        },
                    ],
                    'CopyInfo': 'string',
                    'CurrentState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'DnsName': 'string',
                    'ExpireTime': datetime(2015, 1, 1),
                    'HotAdd': 'string',
                    'ImageId': 'string',
                    'ImageName': 'string',
                    'InstanceId': 'string',
                    'InstanceLifecycle': 'string',
                    'InstanceState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'InstanceType': 'string',
                    'InstanceUniqueId': 'string',
                    'IpAddress': 'string',
                    'IpAddressV6': 'string',
                    'IpType': 'string',
                    'KernelId': 'string',
                    'KeyName': 'string',
                    'LaunchTime': datetime(2015, 1, 1),
                    'Loadbalancing': [
                        {
                            'InstancePort': 123,
                            'LoadBalancerName': 'string',
                            'LoadBalancerPort': 123,
                            'State': 'string'
                        },
                    ],
                    'Monitoring': {
                        'State': 'string'
                    },
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NextMonthAccountingType': 'string',
                    'NiftyElasticLoadBalancing': [
                        {
                            'ElasticLoadBalancerId': 'string',
                            'ElasticLoadBalancerName': 'string',
                            'ElasticLoadBalancerPort': 123,
                            'InstancePort': 123,
                            'Protocol': 'string'
                        },
                    ],
                    'NiftyPrivateIpType': 'string',
                    'NiftyPrivateNetworkType': 'string',
                    'NiftySnapshotting': [
                        {
                            'State': 'string'
                        },
                    ],
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'RegionName': 'string'
                    },
                    'Platform': 'string',
                    'PreviousState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'ProductCodes': [
                        {
                            'ProductCode': 'string'
                        },
                    ],
                    'RamdiskId': 'string',
                    'Reason': 'string',
                    'RegionName': 'string',
                    'RootDeviceName': 'string',
                    'RootDeviceType': 'string',
                    'SpotInstanceRequestId': 'string',
                    'StateReason': {
                        'Code': 123,
                        'Message': 'string'
                    },
                    'SubnetId': 'string',
                    'Tenancy': 'string',
                    'VpcId': 'string'
                },
            ],
            'KeyFingerprint': 'string',
            'KeyName': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • KeySet (list) –
      • (dict) –
        • Description (string) –
        • InstancesSet (list) –
          • (dict) –
            • AccountingType (string) –
            • Admin (string) –
            • AmiLaunchIndex (string) –
            • Architecture (string) –
            • Autoscaling (dict) –
              • AutoScalingGroupName (string) –
              • ExpireTime (datetime) –
            • BlockDeviceMapping (list) –
              • (dict) –
                • DeviceName (string) –
                • Ebs (dict) –
                  • AttachTime (datetime) –
                  • DeleteOnTermination (boolean) –
                  • SnapshotId (string) –
                  • Status (string) –
                  • VolumeId (string) –
                  • VolumeSize (integer) –
                • NoDevice (string) –
                • VirtualName (string) –
            • CopyInfo (string) –
            • CurrentState (dict) –
              • Code (integer) –
              • Name (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • DnsName (string) –
            • ExpireTime (datetime) –
            • HotAdd (string) –
            • ImageId (string) –
            • ImageName (string) –
            • InstanceId (string) –
            • InstanceLifecycle (string) –
            • InstanceState (dict) –
              • Code (integer) –
              • Name (string) –
            • InstanceType (string) –
            • InstanceUniqueId (string) –
            • IpAddress (string) –
            • IpAddressV6 (string) –
            • IpType (string) –
            • KernelId (string) –
            • KeyName (string) –
            • LaunchTime (datetime) –
            • Loadbalancing (list) –
              • (dict) –
                • InstancePort (integer) –
                • LoadBalancerName (string) –
                • LoadBalancerPort (integer) –
                • State (string) –
            • Monitoring (dict) –
              • State (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NextMonthAccountingType (string) –
            • NiftyElasticLoadBalancing (list) –
              • (dict) –
                • ElasticLoadBalancerId (string) –
                • ElasticLoadBalancerName (string) –
                • ElasticLoadBalancerPort (integer) –
                • InstancePort (integer) –
                • Protocol (string) –
            • NiftyPrivateIpType (string) –
            • NiftyPrivateNetworkType (string) –
            • NiftySnapshotting (list) –
              • (dict) –
                • State (string) –
            • Placement (dict) –
              • AvailabilityZone (string) –
              • RegionName (string) –
            • Platform (string) –
            • PreviousState (dict) –
              • Code (integer) –
              • Name (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • ProductCodes (list) –
              • (dict) –
                • ProductCode (string) –
            • RamdiskId (string) –
            • Reason (string) –
            • RegionName (string) –
            • RootDeviceName (string) –
            • RootDeviceType (string) –
            • SpotInstanceRequestId (string) –
            • StateReason (dict) –
              • Code (integer) –
              • Message (string) –
            • SubnetId (string) –
            • Tenancy (string) –
            • VpcId (string) –
        • KeyFingerprint (string) –
        • KeyName (string) –
    • RequestId (string) –
describe_load_balancers(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_load_balancers(
    LoadBalancerNames=[
        {
            'InstancePort': 123,
            'LoadBalancerName': 'string',
            'LoadBalancerPort': 123
        },
    ]
)
Parameters:LoadBalancerNames (list) –
  • (dict) –
    • InstancePort (integer) –
    • LoadBalancerName (string) –
    • LoadBalancerPort (integer) –
Return type:dict
Returns:Response Syntax
{
    'DescribeLoadBalancersResult': {'... recursive ...'},
    'LoadBalancerDescriptions': [
        {
            'AccountingType': 'string',
            'AvailabilityZones': [
                'string',
            ],
            'CreatedTime': datetime(2015, 1, 1),
            'DNSName': 'string',
            'Description': 'string',
            'Filter': {
                'FilterType': 'string',
                'IPAddresses': [
                    {
                        'IPAddress': 'string'
                    },
                ]
            },
            'HealthCheck': {
                'HealthyThreshold': 123,
                'InstanceStates': [
                    {
                        'Description': 'string',
                        'InstanceId': 'string',
                        'InstanceUniqueId': 'string',
                        'ReasonCode': 'string',
                        'State': 'string'
                    },
                ],
                'Interval': 123,
                'Target': 'string',
                'Timeout': 123,
                'UnhealthyThreshold': 123
            },
            'Instances': [
                {
                    'InstanceId': 'string',
                    'InstanceUniqueId': 'string'
                },
            ],
            'ListenerDescriptions': [
                {
                    'Listener': {
                        'BalancingType': 123,
                        'Description': 'string',
                        'ElasticLoadBalancerPort': 123,
                        'HealthCheck': {
                            'HealthyThreshold': 123,
                            'InstanceStates': [
                                {
                                    'Description': 'string',
                                    'InstanceId': 'string',
                                    'InstanceUniqueId': 'string',
                                    'ReasonCode': 'string',
                                    'State': 'string'
                                },
                            ],
                            'Interval': 123,
                            'Target': 'string',
                            'Timeout': 123,
                            'UnhealthyThreshold': 123
                        },
                        'InstancePort': 123,
                        'Instances': [
                            {
                                'InstanceId': 'string',
                                'InstanceUniqueId': 'string'
                            },
                        ],
                        'LoadBalancerPort': 123,
                        'Protocol': 'string',
                        'SSLCertificateId': 'string',
                        'SessionStickinessPolicy': {
                            'Enabled': True|False,
                            'ExpirationPeriod': 123,
                            'Method': 123
                        },
                        'SorryPage': {
                            'Enabled': True|False,
                            'RedirectUrl': 'string',
                            'StatusCode': 123
                        }
                    },
                    'PolicyNames': [
                        'string',
                    ]
                },
            ],
            'LoadBalancerName': 'string',
            'NetworkVolume': 123,
            'NextMonthAccountingType': 'string',
            'Option': {
                'MobileFilter': {
                    'Enabled': True|False
                },
                'NameServer': 'string',
                'SessionStickinessPolicy': {
                    'Enabled': True|False,
                    'ExpirationPeriod': 123,
                    'Method': 123
                },
                'SorryPage': {
                    'Enabled': True|False,
                    'RedirectUrl': 'string',
                    'StatusCode': 123
                }
            },
            'Policies': {
                'AppCookieStickinessPolicies': [
                    {
                        'CookieName': 'string',
                        'PolicyName': 'string'
                    },
                ],
                'LBCookieStickinessPolicies': [
                    {
                        'CookieExpirationPeriod': 'string',
                        'PolicyName': 'string'
                    },
                ]
            }
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • DescribeLoadBalancersResult (dict) –
    • LoadBalancerDescriptions (list) –
      • (dict) –
        • AccountingType (string) –
        • AvailabilityZones (list) –
          • (string) –
        • CreatedTime (datetime) –
        • DNSName (string) –
        • Description (string) –
        • Filter (dict) –
          • FilterType (string) –
          • IPAddresses (list) –
            • (dict) –
              • IPAddress (string) –
        • HealthCheck (dict) –
          • HealthyThreshold (integer) –
          • InstanceStates (list) –
            • (dict) –
              • Description (string) –
              • InstanceId (string) –
              • InstanceUniqueId (string) –
              • ReasonCode (string) –
              • State (string) –
          • Interval (integer) –
          • Target (string) –
          • Timeout (integer) –
          • UnhealthyThreshold (integer) –
        • Instances (list) –
          • (dict) –
            • InstanceId (string) –
            • InstanceUniqueId (string) –
        • ListenerDescriptions (list) –
          • (dict) –
            • Listener (dict) –
              • BalancingType (integer) –
              • Description (string) –
              • ElasticLoadBalancerPort (integer) –
              • HealthCheck (dict) –
                • HealthyThreshold (integer) –
                • InstanceStates (list) –
                  • (dict) –
                    • Description (string) –
                    • InstanceId (string) –
                    • InstanceUniqueId (string) –
                    • ReasonCode (string) –
                    • State (string) –
                • Interval (integer) –
                • Target (string) –
                • Timeout (integer) –
                • UnhealthyThreshold (integer) –
              • InstancePort (integer) –
              • Instances (list) –
                • (dict) –
                  • InstanceId (string) –
                  • InstanceUniqueId (string) –
              • LoadBalancerPort (integer) –
              • Protocol (string) –
              • SSLCertificateId (string) –
              • SessionStickinessPolicy (dict) –
                • Enabled (boolean) –
                • ExpirationPeriod (integer) –
                • Method (integer) –
              • SorryPage (dict) –
                • Enabled (boolean) –
                • RedirectUrl (string) –
                • StatusCode (integer) –
            • PolicyNames (list) –
              • (string) –
        • LoadBalancerName (string) –
        • NetworkVolume (integer) –
        • NextMonthAccountingType (string) –
        • Option (dict) –
          • MobileFilter (dict) –
            • Enabled (boolean) –
          • NameServer (string) –
          • SessionStickinessPolicy (dict) –
            • Enabled (boolean) –
            • ExpirationPeriod (integer) –
            • Method (integer) –
          • SorryPage (dict) –
            • Enabled (boolean) –
            • RedirectUrl (string) –
            • StatusCode (integer) –
        • Policies (dict) –
          • AppCookieStickinessPolicies (list) –
            • (dict) –
              • CookieName (string) –
              • PolicyName (string) –
          • LBCookieStickinessPolicies (list) –
            • (dict) –
              • CookieExpirationPeriod (string) –
              • PolicyName (string) –
    • ResponseMetadata (dict) –
      • RequestId (string) –
describe_regions(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_regions(
    RegionName=[
        'string',
    ]
)
Parameters:RegionName (list) –
  • (string) –
Return type:dict
Returns:Response Syntax
{
    'RegionInfo': [
        {
            'IsDefault': True|False,
            'MessageSet': [
                {
                    'Message': 'string'
                },
            ],
            'RegionEndpoint': 'string',
            'RegionName': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • RegionInfo (list) –
      • (dict) –
        • IsDefault (boolean) –
        • MessageSet (list) –
          • (dict) –
            • Message (string) –
        • RegionEndpoint (string) –
        • RegionName (string) –
    • RequestId (string) –
describe_resources()

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_resources()
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'ResourceInfo': {
        'AddDiskCount': 123,
        'AddDiskTotalSize': 123,
        'AutoScaleCount': 123,
        'CustomizeImageCount': 123,
        'DynamicIpCount': 123,
        'ElasticIpItemSet': [
            {
                'Count': 123,
                'Type': 'string'
            },
        ],
        'ElasticLoadBalancerCount': 123,
        'InstanceItemSet': [
            {
                'Count': 123,
                'Type': 'string'
            },
        ],
        'LoadBalancerCount': 123,
        'MonitoringRuleCount': 123,
        'NetworkFlowAmount': 123,
        'PremiumSupportSet': [
            {
                'Charge': 123,
                'SupportName': 'string',
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'PrivateLanClassicCount': 123,
        'PrivateLanCount': 123,
        'RouterItemSet': [
            {
                'Count': 123,
                'Type': 'string'
            },
        ],
        'SecurityGroupCount': 123,
        'SslCertCount': 123,
        'VpnGatewayItemSet': [
            {
                'Count': 123,
                'Type': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • ResourceInfo (dict) –
      • AddDiskCount (integer) –
      • AddDiskTotalSize (integer) –
      • AutoScaleCount (integer) –
      • CustomizeImageCount (integer) –
      • DynamicIpCount (integer) –
      • ElasticIpItemSet (list) –
        • (dict) –
          • Count (integer) –
          • Type (string) –
      • ElasticLoadBalancerCount (integer) –
      • InstanceItemSet (list) –
        • (dict) –
          • Count (integer) –
          • Type (string) –
      • LoadBalancerCount (integer) –
      • MonitoringRuleCount (integer) –
      • NetworkFlowAmount (integer) –
      • PremiumSupportSet (list) –
        • (dict) –
          • Charge (integer) –
          • SupportName (string) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • PrivateLanClassicCount (integer) –
      • PrivateLanCount (integer) –
      • RouterItemSet (list) –
        • (dict) –
          • Count (integer) –
          • Type (string) –
      • SecurityGroupCount (integer) –
      • SslCertCount (integer) –
      • VpnGatewayItemSet (list) –
        • (dict) –
          • Count (integer) –
          • Type (string) –
describe_route_tables(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_route_tables(
    Filter=[
        {
            'Name': 'string',
            'RequestValue': [
                'string',
            ]
        },
    ],
    RouteTableId=[
        'string',
    ]
)
Parameters:
  • Filter (list) –
    • (dict) –
      • Name (string) –
      • RequestValue (list) –
        • (string) –
  • RouteTableId (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'RouteTableSet': [
        {
            'AssociationSet': [
                {
                    'AssociationId': 'string',
                    'Main': True|False,
                    'NatTableId': 'string',
                    'RouteTableAssociationId': 'string',
                    'RouteTableId': 'string',
                    'RouterId': 'string',
                    'RouterName': 'string',
                    'SubnetId': 'string'
                },
            ],
            'PropagatingVgwSet': [
                {
                    'GatewayId': 'string',
                    'NiftyGatewayName': 'string',
                    'RouteTableAssociationId': 'string'
                },
            ],
            'RouteSet': [
                {
                    'DestinationCidrBlock': 'string',
                    'GatewayId': 'string',
                    'InstanceId': 'string',
                    'InstanceOwnerId': 'string',
                    'IpAddress': 'string',
                    'NetworkId': 'string',
                    'NetworkInterfaceId': 'string',
                    'NetworkName': 'string',
                    'State': 'string'
                },
            ],
            'RouteTableId': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VpcId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • RouteTableSet (list) –
      • (dict) –
        • AssociationSet (list) –
          • (dict) –
            • AssociationId (string) –
            • Main (boolean) –
            • NatTableId (string) –
            • RouteTableAssociationId (string) –
            • RouteTableId (string) –
            • RouterId (string) –
            • RouterName (string) –
            • SubnetId (string) –
        • PropagatingVgwSet (list) –
          • (dict) –
            • GatewayId (string) –
            • NiftyGatewayName (string) –
            • RouteTableAssociationId (string) –
        • RouteSet (list) –
          • (dict) –
            • DestinationCidrBlock (string) –
            • GatewayId (string) –
            • InstanceId (string) –
            • InstanceOwnerId (string) –
            • IpAddress (string) –
            • NetworkId (string) –
            • NetworkInterfaceId (string) –
            • NetworkName (string) –
            • State (string) –
        • RouteTableId (string) –
        • TagSet (list) –
          • (dict) –
            • Key (string) –
            • Value (string) –
        • VpcId (string) –

describe_security_activities(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_security_activities(
    ActivityDate='string',
    GroupName='string',
    Range={
        'All': True|False,
        'EndNumber': 123,
        'StartNumber': 123
    }
)
Parameters:
  • ActivityDate (string) –
  • GroupName (string) –
  • Range (dict) –
    • All (boolean) –
    • EndNumber (integer) –
    • StartNumber (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'GroupName': 'string',
    'Log': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • GroupName (string) –
    • Log (string) –
    • RequestId (string) –

describe_security_group_option()

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_security_group_option()
Return type:dict
Returns:Response Syntax
{
    'Course': 'string',
    'RequestId': 'string',
    'SecurityGroupLimit': 123
}

Response Structure

  • (dict) –
    • Course (string) –
    • RequestId (string) –
    • SecurityGroupLimit (integer) –
describe_security_groups(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_security_groups(
    Filter=[
        {
            'Name': 'string',
            'RequestValue': [
                'string',
            ]
        },
    ],
    GroupName=[
        'string',
    ]
)
Parameters:
  • Filter (list) –
    • (dict) –
      • Name (string) –
      • RequestValue (list) –
        • (string) –
  • GroupName (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'SecurityGroupInfo': [
        {
            'AvailabilityZone': 'string',
            'Description': 'string',
            'GroupDescription': 'string',
            'GroupLogFilterBroadcast': True|False,
            'GroupLogFilterNetBios': True|False,
            'GroupLogLimit': 123,
            'GroupName': 'string',
            'GroupRuleLimit': 123,
            'GroupStatus': 'string',
            'InstanceUniqueIdsSet': [
                {
                    'InstanceUniqueId': 'string'
                },
            ],
            'InstancesNetworkInterfaceSet': [
                {
                    'DeviceIndex': 123,
                    'InstanceId': 'string',
                    'InstanceUniqueId': 'string',
                    'IpAddress': 'string',
                    'NetworkId': 'string'
                },
            ],
            'InstancesSet': [
                {
                    'AccountingType': 'string',
                    'Admin': 'string',
                    'AmiLaunchIndex': 'string',
                    'Architecture': 'string',
                    'Autoscaling': {
                        'AutoScalingGroupName': 'string',
                        'ExpireTime': datetime(2015, 1, 1)
                    },
                    'BlockDeviceMapping': [
                        {
                            'DeviceName': 'string',
                            'Ebs': {
                                'AttachTime': datetime(2015, 1, 1),
                                'DeleteOnTermination': True|False,
                                'SnapshotId': 'string',
                                'Status': 'string',
                                'VolumeId': 'string',
                                'VolumeSize': 123
                            },
                            'NoDevice': 'string',
                            'VirtualName': 'string'
                        },
                    ],
                    'CopyInfo': 'string',
                    'CurrentState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'DnsName': 'string',
                    'ExpireTime': datetime(2015, 1, 1),
                    'HotAdd': 'string',
                    'ImageId': 'string',
                    'ImageName': 'string',
                    'InstanceId': 'string',
                    'InstanceLifecycle': 'string',
                    'InstanceState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'InstanceType': 'string',
                    'InstanceUniqueId': 'string',
                    'IpAddress': 'string',
                    'IpAddressV6': 'string',
                    'IpType': 'string',
                    'KernelId': 'string',
                    'KeyName': 'string',
                    'LaunchTime': datetime(2015, 1, 1),
                    'Loadbalancing': [
                        {
                            'InstancePort': 123,
                            'LoadBalancerName': 'string',
                            'LoadBalancerPort': 123,
                            'State': 'string'
                        },
                    ],
                    'Monitoring': {
                        'State': 'string'
                    },
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NextMonthAccountingType': 'string',
                    'NiftyElasticLoadBalancing': [
                        {
                            'ElasticLoadBalancerId': 'string',
                            'ElasticLoadBalancerName': 'string',
                            'ElasticLoadBalancerPort': 123,
                            'InstancePort': 123,
                            'Protocol': 'string'
                        },
                    ],
                    'NiftyPrivateIpType': 'string',
                    'NiftyPrivateNetworkType': 'string',
                    'NiftySnapshotting': [
                        {
                            'State': 'string'
                        },
                    ],
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'RegionName': 'string'
                    },
                    'Platform': 'string',
                    'PreviousState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'ProductCodes': [
                        {
                            'ProductCode': 'string'
                        },
                    ],
                    'RamdiskId': 'string',
                    'Reason': 'string',
                    'RegionName': 'string',
                    'RootDeviceName': 'string',
                    'RootDeviceType': 'string',
                    'SpotInstanceRequestId': 'string',
                    'StateReason': {
                        'Code': 123,
                        'Message': 'string'
                    },
                    'SubnetId': 'string',
                    'Tenancy': 'string',
                    'VpcId': 'string'
                },
            ],
            'IpPermissions': [
                {
                    'AddDatetime': datetime(2015, 1, 1),
                    'Description': 'string',
                    'FromPort': 123,
                    'Groups': [
                        {
                            'GroupName': 'string',
                            'UserId': 'string'
                        },
                    ],
                    'InOut': 'string',
                    'IpProtocol': 'string',
                    'IpRanges': [
                        {
                            'CidrIp': 'string'
                        },
                    ],
                    'ToPort': 123
                },
            ],
            'OwnerId': 'string',
            'RouterNetworkInterfaceSet': [
                {
                    'DeviceIndex': 123,
                    'IpAddress': 'string',
                    'NetworkId': 'string',
                    'RouterId': 'string',
                    'RouterName': 'string'
                },
            ],
            'RouterSet': [
                {
                    'AccountingType': 'string',
                    'AvailabilityZone': 'string',
                    'CreatedTime': datetime(2015, 1, 1),
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'NatTableAssociationId': 'string',
                    'NatTableId': 'string',
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NextMonthAccountingType': 'string',
                    'RouteTableAssociationId': 'string',
                    'RouteTableId': 'string',
                    'RouterId': 'string',
                    'RouterName': 'string',
                    'State': 'string',
                    'TagSet': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Type': 'string'
                },
            ],
            'VpnGatewayNetworkInterfaceSet': [
                {
                    'DeviceIndex': 123,
                    'IpAddress': 'string',
                    'NetworkId': 'string',
                    'NiftyVpnGatewayName': 'string',
                    'VpnGatewayId': 'string'
                },
            ],
            'VpnGatewaySet': [
                {
                    'AccountingType': 'string',
                    'Attachments': [
                        {
                            'State': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'AvailabilityZone': 'string',
                    'BackupInformation': {
                        'ExpirationDate': datetime(2015, 1, 1),
                        'IsBackup': True|False
                    },
                    'CreatedTime': datetime(2015, 1, 1),
                    'DeviceIndex': 123,
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NiftyRedundancy': True|False,
                    'NiftyVpnGatewayDescription': 'string',
                    'NiftyVpnGatewayName': 'string',
                    'NiftyVpnGatewayType': 'string',
                    'RouteTableAssociationId': 'string',
                    'RouteTableId': 'string',
                    'State': 'string',
                    'TagSet': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Type': 'string',
                    'VersionInformation': {
                        'IsLatest': True|False,
                        'Version': 'string'
                    },
                    'VpnGatewayId': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • SecurityGroupInfo (list) –
      • (dict) –
        • AvailabilityZone (string) –
        • Description (string) –
        • GroupDescription (string) –
        • GroupLogFilterBroadcast (boolean) –
        • GroupLogFilterNetBios (boolean) –
        • GroupLogLimit (integer) –
        • GroupName (string) –
        • GroupRuleLimit (integer) –
        • GroupStatus (string) –
        • InstanceUniqueIdsSet (list) –
          • (dict) –
            • InstanceUniqueId (string) –
        • InstancesNetworkInterfaceSet (list) –
          • (dict) –
            • DeviceIndex (integer) –
            • InstanceId (string) –
            • InstanceUniqueId (string) –
            • IpAddress (string) –
            • NetworkId (string) –
        • InstancesSet (list) –
          • (dict) –
            • AccountingType (string) –
            • Admin (string) –
            • AmiLaunchIndex (string) –
            • Architecture (string) –
            • Autoscaling (dict) –
              • AutoScalingGroupName (string) –
              • ExpireTime (datetime) –
            • BlockDeviceMapping (list) –
              • (dict) –
                • DeviceName (string) –
                • Ebs (dict) –
                  • AttachTime (datetime) –
                  • DeleteOnTermination (boolean) –
                  • SnapshotId (string) –
                  • Status (string) –
                  • VolumeId (string) –
                  • VolumeSize (integer) –
                • NoDevice (string) –
                • VirtualName (string) –
            • CopyInfo (string) –
            • CurrentState (dict) –
              • Code (integer) –
              • Name (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • DnsName (string) –
            • ExpireTime (datetime) –
            • HotAdd (string) –
            • ImageId (string) –
            • ImageName (string) –
            • InstanceId (string) –
            • InstanceLifecycle (string) –
            • InstanceState (dict) –
              • Code (integer) –
              • Name (string) –
            • InstanceType (string) –
            • InstanceUniqueId (string) –
            • IpAddress (string) –
            • IpAddressV6 (string) –
            • IpType (string) –
            • KernelId (string) –
            • KeyName (string) –
            • LaunchTime (datetime) –
            • Loadbalancing (list) –
              • (dict) –
                • InstancePort (integer) –
                • LoadBalancerName (string) –
                • LoadBalancerPort (integer) –
                • State (string) –
            • Monitoring (dict) –
              • State (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NextMonthAccountingType (string) –
            • NiftyElasticLoadBalancing (list) –
              • (dict) –
                • ElasticLoadBalancerId (string) –
                • ElasticLoadBalancerName (string) –
                • ElasticLoadBalancerPort (integer) –
                • InstancePort (integer) –
                • Protocol (string) –
            • NiftyPrivateIpType (string) –
            • NiftyPrivateNetworkType (string) –
            • NiftySnapshotting (list) –
              • (dict) –
                • State (string) –
            • Placement (dict) –
              • AvailabilityZone (string) –
              • RegionName (string) –
            • Platform (string) –
            • PreviousState (dict) –
              • Code (integer) –
              • Name (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • ProductCodes (list) –
              • (dict) –
                • ProductCode (string) –
            • RamdiskId (string) –
            • Reason (string) –
            • RegionName (string) –
            • RootDeviceName (string) –
            • RootDeviceType (string) –
            • SpotInstanceRequestId (string) –
            • StateReason (dict) –
              • Code (integer) –
              • Message (string) –
            • SubnetId (string) –
            • Tenancy (string) –
            • VpcId (string) –
        • IpPermissions (list) –
          • (dict) –
            • AddDatetime (datetime) –
            • Description (string) –
            • FromPort (integer) –
            • Groups (list) –
              • (dict) –
                • GroupName (string) –
                • UserId (string) –
            • InOut (string) –
            • IpProtocol (string) –
            • IpRanges (list) –
              • (dict) –
                • CidrIp (string) –
            • ToPort (integer) –
        • OwnerId (string) –
        • RouterNetworkInterfaceSet (list) –
          • (dict) –
            • DeviceIndex (integer) –
            • IpAddress (string) –
            • NetworkId (string) –
            • RouterId (string) –
            • RouterName (string) –
        • RouterSet (list) –
          • (dict) –
            • AccountingType (string) –
            • AvailabilityZone (string) –
            • CreatedTime (datetime) –
            • Description (string) –
            • DeviceIndex (integer) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • NatTableAssociationId (string) –
            • NatTableId (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NextMonthAccountingType (string) –
            • RouteTableAssociationId (string) –
            • RouteTableId (string) –
            • RouterId (string) –
            • RouterName (string) –
            • State (string) –
            • TagSet (list) –
              • (dict) –
                • Key (string) –
                • Value (string) –
            • Type (string) –
        • VpnGatewayNetworkInterfaceSet (list) –
          • (dict) –
            • DeviceIndex (integer) –
            • IpAddress (string) –
            • NetworkId (string) –
            • NiftyVpnGatewayName (string) –
            • VpnGatewayId (string) –
        • VpnGatewaySet (list) –
          • (dict) –
            • AccountingType (string) –
            • Attachments (list) –
              • (dict) –
                • State (string) –
                • VpcId (string) –
            • AvailabilityZone (string) –
            • BackupInformation (dict) –
              • ExpirationDate (datetime) –
              • IsBackup (boolean) –
            • CreatedTime (datetime) –
            • DeviceIndex (integer) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NiftyRedundancy (boolean) –
            • NiftyVpnGatewayDescription (string) –
            • NiftyVpnGatewayName (string) –
            • NiftyVpnGatewayType (string) –
            • RouteTableAssociationId (string) –
            • RouteTableId (string) –
            • State (string) –
            • TagSet (list) –
              • (dict) –
                • Key (string) –
                • Value (string) –
            • Type (string) –
            • VersionInformation (dict) –
              • IsLatest (boolean) –
              • Version (string) –
            • VpnGatewayId (string) –

describe_service_status(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_service_status(
    FromDate='string',
    ToDate='string'
)
Parameters:
  • FromDate (string) –
  • ToDate (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'ServiceStatusSet': [
        {
            'ControlPanelStatus': 'string',
            'Date': 'string',
            'DiskStatus': 'string',
            'InstanceStatus': 'string',
            'NetworkStatus': 'string',
            'StorageStatus': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • ServiceStatusSet (list) –
      • (dict) –
        • ControlPanelStatus (string) –
        • Date (string) –
        • DiskStatus (string) –
        • InstanceStatus (string) –
        • NetworkStatus (string) –
        • StorageStatus (string) –

describe_ssl_certificate_attribute(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_ssl_certificate_attribute(
    Attribute='string',
    FqdnId='string'
)
Parameters:
  • Attribute (string) –
  • FqdnId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'CaState': {
        'Value': 'string'
    },
    'CertAuthority': {
        'Value': 'string'
    },
    'CertInfo': {
        'CountryName': 'string',
        'EmailAddress': 'string',
        'LocationName': 'string',
        'OrganizationName': 'string',
        'OrganizationUnitName': 'string',
        'StateName': 'string'
    },
    'CertState': {
        'Value': 'string'
    },
    'Count': {
        'Value': 'string'
    },
    'DescriptionValue': {
        'Value': 'string'
    },
    'Fqdn': 'string',
    'FqdnId': 'string',
    'KeyLength': {
        'Value': 'string'
    },
    'Period': {
        'EndDate': datetime(2015, 1, 1),
        'StartDate': datetime(2015, 1, 1),
        'ValidityTerm': 123
    },
    'RequestId': 'string',
    'UploadState': {
        'Value': 'string'
    }
}

Response Structure

  • (dict) –
    • CaState (dict) –
      • Value (string) –
    • CertAuthority (dict) –
      • Value (string) –
    • CertInfo (dict) –
      • CountryName (string) –
      • EmailAddress (string) –
      • LocationName (string) –
      • OrganizationName (string) –
      • OrganizationUnitName (string) –
      • StateName (string) –
    • CertState (dict) –
      • Value (string) –
    • Count (dict) –
      • Value (string) –
    • DescriptionValue (dict) –
      • Value (string) –
    • Fqdn (string) –
    • FqdnId (string) –
    • KeyLength (dict) –
      • Value (string) –
    • Period (dict) –
      • EndDate (datetime) –
      • StartDate (datetime) –
      • ValidityTerm (integer) –
    • RequestId (string) –
    • UploadState (dict) –
      • Value (string) –

describe_ssl_certificates(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_ssl_certificates(
    Fqdn=[
        'string',
    ],
    FqdnId=[
        'string',
    ]
)
Parameters:
  • Fqdn (list) –
    • (string) –
  • FqdnId (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'CertsSet': [
        {
            'CaState': True|False,
            'CertAuthority': 'string',
            'CertInfo': {
                'CountryName': 'string',
                'EmailAddress': 'string',
                'LocationName': 'string',
                'OrganizationName': 'string',
                'OrganizationUnitName': 'string',
                'StateName': 'string'
            },
            'CertState': 'string',
            'Count': 123,
            'Description': 'string',
            'Fqdn': 'string',
            'FqdnId': 'string',
            'KeyLength': 123,
            'Period': {
                'EndDate': datetime(2015, 1, 1),
                'StartDate': datetime(2015, 1, 1),
                'ValidityTerm': 123
            },
            'UploadState': True|False
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • CertsSet (list) –
      • (dict) –
        • CaState (boolean) –
        • CertAuthority (string) –
        • CertInfo (dict) –
          • CountryName (string) –
          • EmailAddress (string) –
          • LocationName (string) –
          • OrganizationName (string) –
          • OrganizationUnitName (string) –
          • StateName (string) –
        • CertState (string) –
        • Count (integer) –
        • Description (string) –
        • Fqdn (string) –
        • FqdnId (string) –
        • KeyLength (integer) –
        • Period (dict) –
          • EndDate (datetime) –
          • StartDate (datetime) –
          • ValidityTerm (integer) –
        • UploadState (boolean) –
    • RequestId (string) –

describe_uploads(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_uploads(
    ConversionTaskId=[
        'string',
    ]
)
Parameters:ConversionTaskId (list) –
  • (string) –
Return type:dict
Returns:Response Syntax
{
    'Uploads': [
        {
            'ConversionTaskId': 123,
            'ExpirationTime': 'string',
            'ImportInstance': {
                'AvailabilityZone': 'string',
                'Description': 'string',
                'Image': {
                    'Checksum': 123,
                    'Format': 'string',
                    'ImportManifestUrl': 'string',
                    'Size': 123
                },
                'InstanceId': 'string',
                'InstanceUniqueId': 'string',
                'Platform': 'string',
                'Volumes': [
                    {
                        'AvailabilityZone': 'string',
                        'BytesConverted': 123,
                        'Description': 'string',
                        'Image': {
                            'Checksum': 123,
                            'Format': 'string',
                            'ImportManifestUrl': 'string',
                            'Size': 123
                        },
                        'Status': 'string',
                        'StatusMessage': 'string',
                        'Volume': {
                            'Id': 'string',
                            'Size': 123
                        }
                    },
                ]
            }
        },
    ]
}

Response Structure

  • (dict) –
    • Uploads (list) –
      • (dict) –
        • ConversionTaskId (integer) –
        • ExpirationTime (string) –
        • ImportInstance (dict) –
          • AvailabilityZone (string) –
          • Description (string) –
          • Image (dict) –
            • Checksum (integer) –
            • Format (string) –
            • ImportManifestUrl (string) –
            • Size (integer) –
          • InstanceId (string) –
          • InstanceUniqueId (string) –
          • Platform (string) –
          • Volumes (list) –
            • (dict) –
              • AvailabilityZone (string) –
              • BytesConverted (integer) –
              • Description (string) –
              • Image (dict) –
                • Checksum (integer) –
                • Format (string) –
                • ImportManifestUrl (string) –
                • Size (integer) –
              • Status (string) –
              • StatusMessage (string) –
              • Volume (dict) –
                • Id (string) –
                • Size (integer) –
describe_usage(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_usage(
    IsCharge=True|False,
    Region='string',
    YearMonth='string'
)
Parameters:
  • IsCharge (boolean) –
  • Region (string) –
  • YearMonth (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AutoScaleInfo': {
        'AutoScaleCount': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'RunningScaleOutInstanceSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'RunningScaleOutOsSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'StoppedScaleOutInstanceSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'StoppedScaleOutOsSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ChargeDetailInfo': {
        'ChargeDetail': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'CopyInfo': {
        'InstanceCopy': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'Value': 'string'
    },
    'ElasticIpInfo': {
        'ElasticIpSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ElasticLoadBalancerInfo': {
        'Vip': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VipMeasuredRate': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ExtraChargeInfo': {
        'ExtraChargeMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'ImageInfo': {
        'CreateImage': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'KeepImageSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'InstanceInfo': {
        'DynamicIpMeasuredRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'DynamicIpMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'InstanceMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'MultiIpMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'OsMeasuredRate': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'OsMonthlyRate': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'RunningInstanceMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'StoppedInstanceMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'InternetVpnInfo': {
        'InternetVpnInitial': {
            'Charge': 123,
            'Value': 123
        },
        'InternetVpnMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'LicenseInfo': {
        'LicenseMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'LoadBalancerInfo': {
        'OptionSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VipMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VipSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'MailSendInfo': {
        'MailSendInitial': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'MailSendMeasuredRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'MailSendMonthlyExceedRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'MailSendMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'OptionSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'MultiAccountInfo': {
        'MultiAccount': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'NetworkInfo': {
        'NetworkFlowSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'OptionCommonInfo': [
        {
            'OptionName': 'string',
            'OptionSet': [
                {
                    'Charge': 123,
                    'Type': 'string',
                    'Unit': 'string',
                    'Value': 123
                },
            ]
        },
    ],
    'OptionInfo': [
        {
            'OptionName': 'string',
            'OptionSet': [
                {
                    'Charge': 123,
                    'Type': 'string',
                    'Unit': 'string',
                    'Value': 123
                },
            ]
        },
    ],
    'OsOptionChargeInfo': {
        'OsOptionChargeMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'PatternAuthInfo': {
        'PatternAuthSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'PremiumSupportInfo': {
        'PremiumSupportSet': [
            {
                'Charge': 123,
                'SupportName': 'string',
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'PrivateLanInfo': {
        'PrivateLan': {
            'AccountingType': 'string',
            'AvailabilityZone': 'string',
            'Charge': 123,
            'CidrBlock': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'InstancesSet': [
                {
                    'AccountingType': 'string',
                    'Admin': 'string',
                    'AmiLaunchIndex': 'string',
                    'Architecture': 'string',
                    'Autoscaling': {
                        'AutoScalingGroupName': 'string',
                        'ExpireTime': datetime(2015, 1, 1)
                    },
                    'BlockDeviceMapping': [
                        {
                            'DeviceName': 'string',
                            'Ebs': {
                                'AttachTime': datetime(2015, 1, 1),
                                'DeleteOnTermination': True|False,
                                'SnapshotId': 'string',
                                'Status': 'string',
                                'VolumeId': 'string',
                                'VolumeSize': 123
                            },
                            'NoDevice': 'string',
                            'VirtualName': 'string'
                        },
                    ],
                    'CopyInfo': 'string',
                    'CurrentState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'DnsName': 'string',
                    'ExpireTime': datetime(2015, 1, 1),
                    'HotAdd': 'string',
                    'ImageId': 'string',
                    'ImageName': 'string',
                    'InstanceId': 'string',
                    'InstanceLifecycle': 'string',
                    'InstanceState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'InstanceType': 'string',
                    'InstanceUniqueId': 'string',
                    'IpAddress': 'string',
                    'IpAddressV6': 'string',
                    'IpType': 'string',
                    'KernelId': 'string',
                    'KeyName': 'string',
                    'LaunchTime': datetime(2015, 1, 1),
                    'Loadbalancing': [
                        {
                            'InstancePort': 123,
                            'LoadBalancerName': 'string',
                            'LoadBalancerPort': 123,
                            'State': 'string'
                        },
                    ],
                    'Monitoring': {
                        'State': 'string'
                    },
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NextMonthAccountingType': 'string',
                    'NiftyElasticLoadBalancing': [
                        {
                            'ElasticLoadBalancerId': 'string',
                            'ElasticLoadBalancerName': 'string',
                            'ElasticLoadBalancerPort': 123,
                            'InstancePort': 123,
                            'Protocol': 'string'
                        },
                    ],
                    'NiftyPrivateIpType': 'string',
                    'NiftyPrivateNetworkType': 'string',
                    'NiftySnapshotting': [
                        {
                            'State': 'string'
                        },
                    ],
                    'Placement': {
                        'AvailabilityZone': 'string',
                        'RegionName': 'string'
                    },
                    'Platform': 'string',
                    'PreviousState': {
                        'Code': 123,
                        'Name': 'string'
                    },
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'ProductCodes': [
                        {
                            'ProductCode': 'string'
                        },
                    ],
                    'RamdiskId': 'string',
                    'Reason': 'string',
                    'RegionName': 'string',
                    'RootDeviceName': 'string',
                    'RootDeviceType': 'string',
                    'SpotInstanceRequestId': 'string',
                    'StateReason': {
                        'Code': 123,
                        'Message': 'string'
                    },
                    'SubnetId': 'string',
                    'Tenancy': 'string',
                    'VpcId': 'string'
                },
            ],
            'PrivateLanId': 'string',
            'PrivateLanName': 'string',
            'RouterSet': [
                {
                    'AccountingType': 'string',
                    'AvailabilityZone': 'string',
                    'CreatedTime': datetime(2015, 1, 1),
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'NatTableAssociationId': 'string',
                    'NatTableId': 'string',
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NextMonthAccountingType': 'string',
                    'RouteTableAssociationId': 'string',
                    'RouteTableId': 'string',
                    'RouterId': 'string',
                    'RouterName': 'string',
                    'State': 'string',
                    'TagSet': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Type': 'string'
                },
            ],
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string',
            'Unit': 'string',
            'Value': 123,
            'VpnGatewaySet': [
                {
                    'AccountingType': 'string',
                    'Attachments': [
                        {
                            'State': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'AvailabilityZone': 'string',
                    'BackupInformation': {
                        'ExpirationDate': datetime(2015, 1, 1),
                        'IsBackup': True|False
                    },
                    'CreatedTime': datetime(2015, 1, 1),
                    'DeviceIndex': 123,
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'NetworkInterfaceSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Attachment': {
                                'AttachTime': datetime(2015, 1, 1),
                                'AttachmentID': 'string',
                                'DeleteOnTermination': True|False,
                                'DeviceIndex': 123,
                                'Status': 'string'
                            },
                            'CidrBlock': 'string',
                            'Descriprion': 'string',
                            'Description': 'string',
                            'DeviceIndex': 123,
                            'Dhcp': True|False,
                            'DhcpOptionsId': 'string',
                            'GroupSet': [
                                {
                                    'GroupId': 'string'
                                },
                            ],
                            'IpAddress': 'string',
                            'MacAddress': 'string',
                            'NetworkId': 'string',
                            'NetworkInterfaceId': 'string',
                            'NetworkName': 'string',
                            'NiftyNetworkId': 'string',
                            'NiftyNetworkName': 'string',
                            'OwnerId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddressV6': 'string',
                            'PrivateIpAddressesSet': [
                                {
                                    'Association': {
                                        'IpOwnerId': 'string',
                                        'PublicDnsName': 'string',
                                        'PublicIp': 'string',
                                        'PublicIpV6': 'string'
                                    },
                                    'Primary': True|False,
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'SourceDestCheck': 'string',
                            'Status': 'string',
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'NiftyRedundancy': True|False,
                    'NiftyVpnGatewayDescription': 'string',
                    'NiftyVpnGatewayName': 'string',
                    'NiftyVpnGatewayType': 'string',
                    'RouteTableAssociationId': 'string',
                    'RouteTableId': 'string',
                    'State': 'string',
                    'TagSet': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Type': 'string',
                    'VersionInformation': {
                        'IsLatest': True|False,
                        'Version': 'string'
                    },
                    'VpnGatewayId': 'string'
                },
            ]
        }
    },
    'PrivateNetworkInfo': {
        'PrivateNetworkMeasuredRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'PrivateNetworkMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'RequestId': 'string',
    'RouterInfo': {
        'RouterMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'RouterMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'SecureNetInfo': {
        'SecureNetMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'VpnConnectMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'SecurityGroupInfo': {
        'OptionSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'SecurityGroupApplyTime': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'SnapshotInfo': {
        'Snapshot': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'SslCertInfo': {
        'CreateSslCertSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'StorageInfo': {
        'StorageMeasuredRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'StorageMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        }
    },
    'VolumeInfo': {
        'ImportInstanceDiskMeasuredRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'ImportInstanceDiskMonthlyRate': {
            'Charge': 123,
            'Type': 'string',
            'Unit': 'string',
            'Value': 123
        },
        'VolumeMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VolumeSet': [
            {
                'AccountingType': 'string',
                'AttachmentSet': [
                    {
                        'AttachTime': datetime(2015, 1, 1),
                        'DeleteOnTermination': True|False,
                        'Device': 'string',
                        'InstanceId': 'string',
                        'InstanceUniqueId': 'string',
                        'Status': 'string',
                        'VolumeId': 'string'
                    },
                ],
                'AvailabilityZone': 'string',
                'Charge': 123,
                'CreateTime': datetime(2015, 1, 1),
                'DiskType': 'string',
                'NextMonthAccountingType': 'string',
                'Size': 'string',
                'SnapshotId': 'string',
                'Status': 'string',
                'Type': 'string',
                'Unit': 'string',
                'Value': 123,
                'VolumeId': 'string'
            },
        ]
    },
    'VpnGatewayInfo': {
        'VpnGatewayMeasuredRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ],
        'VpnGatewayMonthlyRateSet': [
            {
                'Charge': 123,
                'Type': 'string',
                'Unit': 'string',
                'Value': 123
            },
        ]
    },
    'YearMonth': 'string'
}

Response Structure

  • (dict) –
    • AutoScaleInfo (dict) –
      • AutoScaleCount (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • RunningScaleOutInstanceSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • RunningScaleOutOsSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • StoppedScaleOutInstanceSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • StoppedScaleOutOsSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • ChargeDetailInfo (dict) –
      • ChargeDetail (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
    • CopyInfo (dict) –
      • InstanceCopy (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • Value (string) –
    • ElasticIpInfo (dict) –
      • ElasticIpSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • ElasticLoadBalancerInfo (dict) –
      • Vip (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • VipMeasuredRate (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • ExtraChargeInfo (dict) –
      • ExtraChargeMonthlyRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • ImageInfo (dict) –
      • CreateImage (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • KeepImageSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • InstanceInfo (dict) –
      • DynamicIpMeasuredRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • DynamicIpMonthlyRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • InstanceMonthlyRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • MultiIpMonthlyRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • OsMeasuredRate (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • OsMonthlyRate (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • RunningInstanceMeasuredRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • StoppedInstanceMeasuredRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • InternetVpnInfo (dict) –
      • InternetVpnInitial (dict) –
        • Charge (integer) –
        • Value (integer) –
      • InternetVpnMonthlyRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • LicenseInfo (dict) –
      • LicenseMonthlyRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • LoadBalancerInfo (dict) –
      • OptionSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • VipMeasuredRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • VipSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • MailSendInfo (dict) –
      • MailSendInitial (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • MailSendMeasuredRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • MailSendMonthlyExceedRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • MailSendMonthlyRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • OptionSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • MultiAccountInfo (dict) –
      • MultiAccount (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
    • NetworkInfo (dict) –
      • NetworkFlowSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • OptionCommonInfo (list) –
      • (dict) –
        • OptionName (string) –
        • OptionSet (list) –
          • (dict) –
            • Charge (integer) –
            • Type (string) –
            • Unit (string) –
            • Value (integer) –
    • OptionInfo (list) –
      • (dict) –
        • OptionName (string) –
        • OptionSet (list) –
          • (dict) –
            • Charge (integer) –
            • Type (string) –
            • Unit (string) –
            • Value (integer) –
    • OsOptionChargeInfo (dict) –
      • OsOptionChargeMonthlyRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • PatternAuthInfo (dict) –
      • PatternAuthSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • PremiumSupportInfo (dict) –
      • PremiumSupportSet (list) –
        • (dict) –
          • Charge (integer) –
          • SupportName (string) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • PrivateLanInfo (dict) –
      • PrivateLan (dict) –
        • AccountingType (string) –
        • AvailabilityZone (string) –
        • Charge (integer) –
        • CidrBlock (string) –
        • CreatedTime (datetime) –
        • Description (string) –
        • InstancesSet (list) –
          • (dict) –
            • AccountingType (string) –
            • Admin (string) –
            • AmiLaunchIndex (string) –
            • Architecture (string) –
            • Autoscaling (dict) –
              • AutoScalingGroupName (string) –
              • ExpireTime (datetime) –
            • BlockDeviceMapping (list) –
              • (dict) –
                • DeviceName (string) –
                • Ebs (dict) –
                  • AttachTime (datetime) –
                  • DeleteOnTermination (boolean) –
                  • SnapshotId (string) –
                  • Status (string) –
                  • VolumeId (string) –
                  • VolumeSize (integer) –
                • NoDevice (string) –
                • VirtualName (string) –
            • CopyInfo (string) –
            • CurrentState (dict) –
              • Code (integer) –
              • Name (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • DnsName (string) –
            • ExpireTime (datetime) –
            • HotAdd (string) –
            • ImageId (string) –
            • ImageName (string) –
            • InstanceId (string) –
            • InstanceLifecycle (string) –
            • InstanceState (dict) –
              • Code (integer) –
              • Name (string) –
            • InstanceType (string) –
            • InstanceUniqueId (string) –
            • IpAddress (string) –
            • IpAddressV6 (string) –
            • IpType (string) –
            • KernelId (string) –
            • KeyName (string) –
            • LaunchTime (datetime) –
            • Loadbalancing (list) –
              • (dict) –
                • InstancePort (integer) –
                • LoadBalancerName (string) –
                • LoadBalancerPort (integer) –
                • State (string) –
            • Monitoring (dict) –
              • State (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NextMonthAccountingType (string) –
            • NiftyElasticLoadBalancing (list) –
              • (dict) –
                • ElasticLoadBalancerId (string) –
                • ElasticLoadBalancerName (string) –
                • ElasticLoadBalancerPort (integer) –
                • InstancePort (integer) –
                • Protocol (string) –
            • NiftyPrivateIpType (string) –
            • NiftyPrivateNetworkType (string) –
            • NiftySnapshotting (list) –
              • (dict) –
                • State (string) –
            • Placement (dict) –
              • AvailabilityZone (string) –
              • RegionName (string) –
            • Platform (string) –
            • PreviousState (dict) –
              • Code (integer) –
              • Name (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • ProductCodes (list) –
              • (dict) –
                • ProductCode (string) –
            • RamdiskId (string) –
            • Reason (string) –
            • RegionName (string) –
            • RootDeviceName (string) –
            • RootDeviceType (string) –
            • SpotInstanceRequestId (string) –
            • StateReason (dict) –
              • Code (integer) –
              • Message (string) –
            • SubnetId (string) –
            • Tenancy (string) –
            • VpcId (string) –
        • PrivateLanId (string) –
        • PrivateLanName (string) –
        • RouterSet (list) –
          • (dict) –
            • AccountingType (string) –
            • AvailabilityZone (string) –
            • CreatedTime (datetime) –
            • Description (string) –
            • DeviceIndex (integer) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • NatTableAssociationId (string) –
            • NatTableId (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NextMonthAccountingType (string) –
            • RouteTableAssociationId (string) –
            • RouteTableId (string) –
            • RouterId (string) –
            • RouterName (string) –
            • State (string) –
            • TagSet (list) –
              • (dict) –
                • Key (string) –
                • Value (string) –
            • Type (string) –
        • State (string) –
        • TagSet (list) –
          • (dict) –
            • Key (string) –
            • Value (string) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
        • VpnGatewaySet (list) –
          • (dict) –
            • AccountingType (string) –
            • Attachments (list) –
              • (dict) –
                • State (string) –
                • VpcId (string) –
            • AvailabilityZone (string) –
            • BackupInformation (dict) –
              • ExpirationDate (datetime) –
              • IsBackup (boolean) –
            • CreatedTime (datetime) –
            • DeviceIndex (integer) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • NetworkInterfaceSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Attachment (dict) –
                  • AttachTime (datetime) –
                  • AttachmentID (string) –
                  • DeleteOnTermination (boolean) –
                  • DeviceIndex (integer) –
                  • Status (string) –
                • CidrBlock (string) –
                • Descriprion (string) –
                • Description (string) –
                • DeviceIndex (integer) –
                • Dhcp (boolean) –
                • DhcpOptionsId (string) –
                • GroupSet (list) –
                  • (dict) –
                    • GroupId (string) –
                • IpAddress (string) –
                • MacAddress (string) –
                • NetworkId (string) –
                • NetworkInterfaceId (string) –
                • NetworkName (string) –
                • NiftyNetworkId (string) –
                • NiftyNetworkName (string) –
                • OwnerId (string) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
                • PrivateIpAddressV6 (string) –
                • PrivateIpAddressesSet (list) –
                  • (dict) –
                    • Association (dict) –
                      • IpOwnerId (string) –
                      • PublicDnsName (string) –
                      • PublicIp (string) –
                      • PublicIpV6 (string) –
                    • Primary (boolean) –
                    • PrivateDnsName (string) –
                    • PrivateIpAddress (string) –
                • SourceDestCheck (string) –
                • Status (string) –
                • SubnetId (string) –
                • VpcId (string) –
            • NiftyRedundancy (boolean) –
            • NiftyVpnGatewayDescription (string) –
            • NiftyVpnGatewayName (string) –
            • NiftyVpnGatewayType (string) –
            • RouteTableAssociationId (string) –
            • RouteTableId (string) –
            • State (string) –
            • TagSet (list) –
              • (dict) –
                • Key (string) –
                • Value (string) –
            • Type (string) –
            • VersionInformation (dict) –
              • IsLatest (boolean) –
              • Version (string) –
            • VpnGatewayId (string) –
    • PrivateNetworkInfo (dict) –
      • PrivateNetworkMeasuredRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • PrivateNetworkMonthlyRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
    • RequestId (string) –
    • RouterInfo (dict) –
      • RouterMeasuredRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • RouterMonthlyRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • SecureNetInfo (dict) –
      • SecureNetMonthlyRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • VpnConnectMeasuredRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • SecurityGroupInfo (dict) –
      • OptionSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • SecurityGroupApplyTime (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
    • SnapshotInfo (dict) –
      • Snapshot (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
    • SslCertInfo (dict) –
      • CreateSslCertSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • StorageInfo (dict) –
      • StorageMeasuredRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • StorageMonthlyRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
    • VolumeInfo (dict) –
      • ImportInstanceDiskMeasuredRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • ImportInstanceDiskMonthlyRate (dict) –
        • Charge (integer) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
      • VolumeMeasuredRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • VolumeSet (list) –
        • (dict) –
          • AccountingType (string) –
          • AttachmentSet (list) –
            • (dict) –
              • AttachTime (datetime) –
              • DeleteOnTermination (boolean) –
              • Device (string) –
              • InstanceId (string) –
              • InstanceUniqueId (string) –
              • Status (string) –
              • VolumeId (string) –
          • AvailabilityZone (string) –
          • Charge (integer) –
          • CreateTime (datetime) –
          • DiskType (string) –
          • NextMonthAccountingType (string) –
          • Size (string) –
          • SnapshotId (string) –
          • Status (string) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
          • VolumeId (string) –
    • VpnGatewayInfo (dict) –
      • VpnGatewayMeasuredRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
      • VpnGatewayMonthlyRateSet (list) –
        • (dict) –
          • Charge (integer) –
          • Type (string) –
          • Unit (string) –
          • Value (integer) –
    • YearMonth (string) –

describe_user_activities(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_user_activities(
    Range={
        'All': True|False,
        'EndNumber': 123,
        'StartNumber': 123
    },
    YearMonth='string'
)
Parameters:
  • Range (dict) –
    • All (boolean) –
    • EndNumber (integer) –
    • StartNumber (integer) –
  • YearMonth (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'UserActivitiesSet': [
        {
            'CategoryName': 'string',
            'DateTime': datetime(2015, 1, 1),
            'IpAddress': 'string',
            'Operation': 'string',
            'Operator': 'string',
            'Result': True|False
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • UserActivitiesSet (list) –
      • (dict) –
        • CategoryName (string) –
        • DateTime (datetime) –
        • IpAddress (string) –
        • Operation (string) –
        • Operator (string) –
        • Result (boolean) –

describe_volumes(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_volumes(
    VolumeId=[
        'string',
    ]
)
Parameters:VolumeId (list) –
  • (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'VolumeSet': [
        {
            'AccountingType': 'string',
            'AttachmentSet': [
                {
                    'AttachTime': datetime(2015, 1, 1),
                    'DeleteOnTermination': True|False,
                    'Device': 'string',
                    'InstanceId': 'string',
                    'InstanceUniqueId': 'string',
                    'Status': 'string',
                    'VolumeId': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'Charge': 123,
            'CreateTime': datetime(2015, 1, 1),
            'DiskType': 'string',
            'NextMonthAccountingType': 'string',
            'Size': 'string',
            'SnapshotId': 'string',
            'Status': 'string',
            'Type': 'string',
            'Unit': 'string',
            'Value': 123,
            'VolumeId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • VolumeSet (list) –
      • (dict) –
        • AccountingType (string) –
        • AttachmentSet (list) –
          • (dict) –
            • AttachTime (datetime) –
            • DeleteOnTermination (boolean) –
            • Device (string) –
            • InstanceId (string) –
            • InstanceUniqueId (string) –
            • Status (string) –
            • VolumeId (string) –
        • AvailabilityZone (string) –
        • Charge (integer) –
        • CreateTime (datetime) –
        • DiskType (string) –
        • NextMonthAccountingType (string) –
        • Size (string) –
        • SnapshotId (string) –
        • Status (string) –
        • Type (string) –
        • Unit (string) –
        • Value (integer) –
        • VolumeId (string) –
describe_vpn_connections(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_vpn_connections(
    Filter=[
        {
            'Name': 'string',
            'RequestValue': [
                'string',
            ]
        },
    ],
    VpnConnectionId=[
        'string',
    ]
)
Parameters:
  • Filter (list) –
    • (dict) –
      • Name (string) –
      • RequestValue (list) –
        • (string) –
  • VpnConnectionId (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VpnConnectionSet': [
        {
            'CreatedTime': datetime(2015, 1, 1),
            'CustomerGatewayConfiguration': 'string',
            'CustomerGatewayId': 'string',
            'NiftyCustomerGatewayName': 'string',
            'NiftyIpsecConfiguration': {
                'EncryptionAlgorithm': 'string',
                'HashingAlgorithm': 'string',
                'InternetKeyExchange': 'string',
                'Mtu': 'string',
                'PreSharedKey': 'string'
            },
            'NiftyTunnel': {
                'DestinationPort': 'string',
                'Encapsulation': 'string',
                'Mode': 'string',
                'PeerSessionId': 'string',
                'PeerTunnelId': 'string',
                'SessionId': 'string',
                'SourcePort': 'string',
                'TunnelId': 'string',
                'Type': 'string'
            },
            'NiftyVpnConnectionDescription': 'string',
            'NiftyVpnGatewayName': 'string',
            'Options': {
                'StaticRoutesOnly': True|False
            },
            'Routes': {
                'DestinationCidrBlock': 'string',
                'Source': 'string',
                'State': 'string'
            },
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string',
            'VgwTelemetry': [
                {
                    'AcceptedRouteCount': 123,
                    'LastStatusChange': datetime(2015, 1, 1),
                    'OutsideIpAddress': 'string',
                    'Status': 'string',
                    'StatusMessage': 'string'
                },
            ],
            'VpnConnectionId': 'string',
            'VpnGatewayId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • VpnConnectionSet (list) –
      • (dict) –
        • CreatedTime (datetime) –
        • CustomerGatewayConfiguration (string) –
        • CustomerGatewayId (string) –
        • NiftyCustomerGatewayName (string) –
        • NiftyIpsecConfiguration (dict) –
          • EncryptionAlgorithm (string) –
          • HashingAlgorithm (string) –
          • InternetKeyExchange (string) –
          • Mtu (string) –
          • PreSharedKey (string) –
        • NiftyTunnel (dict) –
          • DestinationPort (string) –
          • Encapsulation (string) –
          • Mode (string) –
          • PeerSessionId (string) –
          • PeerTunnelId (string) –
          • SessionId (string) –
          • SourcePort (string) –
          • TunnelId (string) –
          • Type (string) –
        • NiftyVpnConnectionDescription (string) –
        • NiftyVpnGatewayName (string) –
        • Options (dict) –
          • StaticRoutesOnly (boolean) –
        • Routes (dict) –
          • DestinationCidrBlock (string) –
          • Source (string) –
          • State (string) –
        • State (string) –
        • TagSet (list) –
          • (dict) –
            • Key (string) –
            • Value (string) –
        • Type (string) –
        • VgwTelemetry (list) –
          • (dict) –
            • AcceptedRouteCount (integer) –
            • LastStatusChange (datetime) –
            • OutsideIpAddress (string) –
            • Status (string) –
            • StatusMessage (string) –
        • VpnConnectionId (string) –
        • VpnGatewayId (string) –

describe_vpn_gateways(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.describe_vpn_gateways(
    Filter=[
        {
            'Name': 'string',
            'RequestValue': [
                'string',
            ]
        },
    ],
    NiftyVpnGatewayName=[
        'string',
    ],
    VpnGatewayId=[
        'string',
    ]
)
Parameters:
  • Filter (list) –
    • (dict) –
      • Name (string) –
      • RequestValue (list) –
        • (string) –
  • NiftyVpnGatewayName (list) –
    • (string) –
  • VpnGatewayId (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VpnGatewaySet': [
        {
            'AccountingType': 'string',
            'Attachments': [
                {
                    'State': 'string',
                    'VpcId': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'BackupInformation': {
                'ExpirationDate': datetime(2015, 1, 1),
                'IsBackup': True|False
            },
            'CreatedTime': datetime(2015, 1, 1),
            'DeviceIndex': 123,
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'IpAddress': 'string',
            'NetworkInterfaceSet': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'PublicIpV6': 'string'
                    },
                    'Attachment': {
                        'AttachTime': datetime(2015, 1, 1),
                        'AttachmentID': 'string',
                        'DeleteOnTermination': True|False,
                        'DeviceIndex': 123,
                        'Status': 'string'
                    },
                    'CidrBlock': 'string',
                    'Descriprion': 'string',
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'Dhcp': True|False,
                    'DhcpOptionsId': 'string',
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'MacAddress': 'string',
                    'NetworkId': 'string',
                    'NetworkInterfaceId': 'string',
                    'NetworkName': 'string',
                    'NiftyNetworkId': 'string',
                    'NiftyNetworkName': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'PrivateIpAddressesSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Primary': True|False,
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SourceDestCheck': 'string',
                    'Status': 'string',
                    'SubnetId': 'string',
                    'VpcId': 'string'
                },
            ],
            'NiftyRedundancy': True|False,
            'NiftyVpnGatewayDescription': 'string',
            'NiftyVpnGatewayName': 'string',
            'NiftyVpnGatewayType': 'string',
            'RouteTableAssociationId': 'string',
            'RouteTableId': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string',
            'VersionInformation': {
                'IsLatest': True|False,
                'Version': 'string'
            },
            'VpnGatewayId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • VpnGatewaySet (list) –
      • (dict) –
        • AccountingType (string) –
        • Attachments (list) –
          • (dict) –
            • State (string) –
            • VpcId (string) –
        • AvailabilityZone (string) –
        • BackupInformation (dict) –
          • ExpirationDate (datetime) –
          • IsBackup (boolean) –
        • CreatedTime (datetime) –
        • DeviceIndex (integer) –
        • GroupSet (list) –
          • (dict) –
            • GroupId (string) –
        • IpAddress (string) –
        • NetworkInterfaceSet (list) –
          • (dict) –
            • Association (dict) –
              • IpOwnerId (string) –
              • PublicDnsName (string) –
              • PublicIp (string) –
              • PublicIpV6 (string) –
            • Attachment (dict) –
              • AttachTime (datetime) –
              • AttachmentID (string) –
              • DeleteOnTermination (boolean) –
              • DeviceIndex (integer) –
              • Status (string) –
            • CidrBlock (string) –
            • Descriprion (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • Dhcp (boolean) –
            • DhcpOptionsId (string) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • MacAddress (string) –
            • NetworkId (string) –
            • NetworkInterfaceId (string) –
            • NetworkName (string) –
            • NiftyNetworkId (string) –
            • NiftyNetworkName (string) –
            • OwnerId (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • PrivateIpAddressesSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Primary (boolean) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
            • SourceDestCheck (string) –
            • Status (string) –
            • SubnetId (string) –
            • VpcId (string) –
        • NiftyRedundancy (boolean) –
        • NiftyVpnGatewayDescription (string) –
        • NiftyVpnGatewayName (string) –
        • NiftyVpnGatewayType (string) –
        • RouteTableAssociationId (string) –
        • RouteTableId (string) –
        • State (string) –
        • TagSet (list) –
          • (dict) –
            • Key (string) –
            • Value (string) –
        • Type (string) –
        • VersionInformation (dict) –
          • IsLatest (boolean) –
          • Version (string) –
        • VpnGatewayId (string) –

detach_volume(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.detach_volume(
    Agreement=True|False,
    InstanceId='string',
    VolumeId='string'
)
Parameters:
  • Agreement (boolean) –
  • InstanceId (string) –
  • VolumeId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AttachTime': datetime(2015, 1, 1),
    'Device': 'string',
    'InstanceId': 'string',
    'InstanceUniqueId': 'string',
    'RequestId': 'string',
    'Status': 'string',
    'VolumeId': 'string'
}

Response Structure

  • (dict) –
    • AttachTime (datetime) –
    • Device (string) –
    • InstanceId (string) –
    • InstanceUniqueId (string) –
    • RequestId (string) –
    • Status (string) –
    • VolumeId (string) –

disassociate_address(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.disassociate_address(
    NiftyReboot='string',
    PrivateIpAddress='string',
    PublicIp='string'
)
Parameters:
  • NiftyReboot (string) –
  • PrivateIpAddress (string) –
  • PublicIp (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

disassociate_route_table(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.disassociate_route_table(
    Agreement=True|False,
    AssociationId='string'
)
Parameters:
  • Agreement (boolean) –
  • AssociationId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

dissociate_users(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.dissociate_users(
    FunctionName='string',
    Users=[
        {
            'UserId': 'string'
        },
    ]
)
Parameters:
  • FunctionName (string) –
  • Users (list) –
    • (dict) –
      • UserId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'DissociateUsersResult': {'... recursive ...'},
    'ResponseMetadata': {
        'RequestId': 'string'
    },
    'Users': [
        {
            'UserId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • DissociateUsersResult (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –
    • Users (list) –
      • (dict) –
        • UserId (string) –

download_ssl_certificate(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.download_ssl_certificate(
    FileType='string',
    FqdnId='string'
)
Parameters:
  • FileType (string) –
  • FqdnId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'FileData': 'string',
    'Fqdn': 'string',
    'FqdnId': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • FileData (string) –
    • Fqdn (string) –
    • FqdnId (string) –
    • RequestId (string) –

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters:
  • ClientMethod (string) – The client method to presign for
  • Params (dict) – The parameters normally passed to ClientMethod.
  • ExpiresIn (int) – The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) – The http method to use on the generated url. By default, the http method is whatever is used in the method’s model.
Returns:

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters:operation_name (string) – The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you’d normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises:OperationNotPageableError – Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type:L{botocore.paginate.Paginator}
Returns:A paginator object.
get_waiter(waiter_name)
import_instance(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.import_instance(
    AccountingType='string',
    Description='string',
    InstanceId='string',
    InstanceType='string',
    IpType='string',
    NetworkInterface=[
        {
            'DeviceIndex': 123,
            'Dhcp': True|False,
            'DhcpConfigId': 'string',
            'DhcpOptionsId': 'string',
            'IpAddress': 'string',
            'IsVipNetwork': True|False,
            'NetworkId': 'string',
            'NetworkName': 'string',
            'RequestSecurityGroupId': [
                'string',
            ]
        },
    ],
    Ovf='string',
    Placement={
        'AvailabilityZone': 'string',
        'RegionName': 'string'
    },
    PublicIp='string',
    SecurityGroup=[
        'string',
    ]
)
Parameters:
  • AccountingType (string) –
  • Description (string) –
  • InstanceId (string) –
  • InstanceType (string) –
  • IpType (string) –
  • NetworkInterface (list) –
    • (dict) –
      • DeviceIndex (integer) –
      • Dhcp (boolean) –
      • DhcpConfigId (string) –
      • DhcpOptionsId (string) –
      • IpAddress (string) –
      • IsVipNetwork (boolean) –
      • NetworkId (string) –
      • NetworkName (string) –
      • RequestSecurityGroupId (list) –
        • (string) –
  • Ovf (string) –
  • Placement (dict) –
    • AvailabilityZone (string) –
    • RegionName (string) –
  • PublicIp (string) –
  • SecurityGroup (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'ConversionTask': {
        'ConversionTaskId': 'string',
        'ExpirationTime': 'string',
        'ImportInstance': {
            'AvailabilityZone': 'string',
            'Description': 'string',
            'Image': {
                'Checksum': 123,
                'Format': 'string',
                'ImportManifestUrl': 'string',
                'Size': 123
            },
            'InstanceId': 'string',
            'InstanceUniqueId': 'string',
            'Platform': 'string',
            'Volumes': [
                {
                    'AvailabilityZone': 'string',
                    'BytesConverted': 123,
                    'Description': 'string',
                    'Image': {
                        'Checksum': 123,
                        'Format': 'string',
                        'ImportManifestUrl': 'string',
                        'Size': 123
                    },
                    'Status': 'string',
                    'StatusMessage': 'string',
                    'Volume': {
                        'Id': 'string',
                        'Size': 123
                    }
                },
            ]
        },
        'NetworkInterfaceSet': [
            {
                'Association': {
                    'IpOwnerId': 'string',
                    'PublicDnsName': 'string',
                    'PublicIp': 'string',
                    'PublicIpV6': 'string'
                },
                'Attachment': {
                    'AttachTime': datetime(2015, 1, 1),
                    'AttachmentID': 'string',
                    'DeleteOnTermination': True|False,
                    'DeviceIndex': 123,
                    'Status': 'string'
                },
                'CidrBlock': 'string',
                'Descriprion': 'string',
                'Description': 'string',
                'DeviceIndex': 123,
                'Dhcp': True|False,
                'DhcpOptionsId': 'string',
                'GroupSet': [
                    {
                        'GroupId': 'string'
                    },
                ],
                'IpAddress': 'string',
                'MacAddress': 'string',
                'NetworkId': 'string',
                'NetworkInterfaceId': 'string',
                'NetworkName': 'string',
                'NiftyNetworkId': 'string',
                'NiftyNetworkName': 'string',
                'OwnerId': 'string',
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddressV6': 'string',
                'PrivateIpAddressesSet': [
                    {
                        'Association': {
                            'IpOwnerId': 'string',
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'PublicIpV6': 'string'
                        },
                        'Primary': True|False,
                        'PrivateDnsName': 'string',
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SourceDestCheck': 'string',
                'Status': 'string',
                'SubnetId': 'string',
                'VpcId': 'string'
            },
        ],
        'State': 'string',
        'StatusMessage': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –
    • ConversionTask (dict) –
      • ConversionTaskId (string) –
      • ExpirationTime (string) –
      • ImportInstance (dict) –
        • AvailabilityZone (string) –
        • Description (string) –
        • Image (dict) –
          • Checksum (integer) –
          • Format (string) –
          • ImportManifestUrl (string) –
          • Size (integer) –
        • InstanceId (string) –
        • InstanceUniqueId (string) –
        • Platform (string) –
        • Volumes (list) –
          • (dict) –
            • AvailabilityZone (string) –
            • BytesConverted (integer) –
            • Description (string) –
            • Image (dict) –
              • Checksum (integer) –
              • Format (string) –
              • ImportManifestUrl (string) –
              • Size (integer) –
            • Status (string) –
            • StatusMessage (string) –
            • Volume (dict) –
              • Id (string) –
              • Size (integer) –
      • NetworkInterfaceSet (list) –
        • (dict) –
          • Association (dict) –
            • IpOwnerId (string) –
            • PublicDnsName (string) –
            • PublicIp (string) –
            • PublicIpV6 (string) –
          • Attachment (dict) –
            • AttachTime (datetime) –
            • AttachmentID (string) –
            • DeleteOnTermination (boolean) –
            • DeviceIndex (integer) –
            • Status (string) –
          • CidrBlock (string) –
          • Descriprion (string) –
          • Description (string) –
          • DeviceIndex (integer) –
          • Dhcp (boolean) –
          • DhcpOptionsId (string) –
          • GroupSet (list) –
            • (dict) –
              • GroupId (string) –
          • IpAddress (string) –
          • MacAddress (string) –
          • NetworkId (string) –
          • NetworkInterfaceId (string) –
          • NetworkName (string) –
          • NiftyNetworkId (string) –
          • NiftyNetworkName (string) –
          • OwnerId (string) –
          • PrivateDnsName (string) –
          • PrivateIpAddress (string) –
          • PrivateIpAddressV6 (string) –
          • PrivateIpAddressesSet (list) –
            • (dict) –
              • Association (dict) –
                • IpOwnerId (string) –
                • PublicDnsName (string) –
                • PublicIp (string) –
                • PublicIpV6 (string) –
              • Primary (boolean) –
              • PrivateDnsName (string) –
              • PrivateIpAddress (string) –
          • SourceDestCheck (string) –
          • Status (string) –
          • SubnetId (string) –
          • VpcId (string) –
      • State (string) –
      • StatusMessage (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –

import_key_pair(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.import_key_pair(
    Description='string',
    KeyName='string',
    PublicKeyMaterial='string'
)
Parameters:
  • Description (string) –
  • KeyName (string) –
  • PublicKeyMaterial (string) –
Return type:

dict

Returns:

Response Syntax

{
    'KeyFingerprint': 'string',
    'KeyName': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • KeyFingerprint (string) –
    • KeyName (string) –
    • RequestId (string) –

modify_image_attribute(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_image_attribute(
    Attribute='string',
    ImageId='string',
    Value='string'
)
Parameters:
  • Attribute (string) –
  • ImageId (string) –
  • Value (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • RequestId (string) –

modify_instance_attribute(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_instance_attribute(
    Attribute='string',
    Force=True|False,
    InstanceId='string',
    NiftyReboot='string',
    Tenancy='string',
    Value='string'
)
Parameters:
  • Attribute (string) –
  • Force (boolean) –
  • InstanceId (string) –
  • NiftyReboot (string) –
  • Tenancy (string) –
  • Value (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

modify_ssl_certificate_attribute(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_ssl_certificate_attribute(
    Description={
        'Value': 'string'
    },
    FqdnId='string'
)
Parameters:
  • Description (dict) –
    • Value (string) –
  • FqdnId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

modify_volume_attribute(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.modify_volume_attribute(
    Attribute='string',
    Value='string',
    VolumeId='string'
)
Parameters:
  • Attribute (string) –
  • Value (string) –
  • VolumeId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_associate_image(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_associate_image(
    DistributionId=[
        'string',
    ],
    ImageId='string',
    IsPublic=True|False,
    IsRedistribute=True|False
)
Parameters:
  • DistributionId (list) –
    • (string) –
  • ImageId (string) –
  • IsPublic (boolean) –
  • IsRedistribute (boolean) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_associate_nat_table(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_associate_nat_table(
    Agreement=True|False,
    NatTableId='string',
    RouterId='string',
    RouterName='string'
)
Parameters:
  • Agreement (boolean) –
  • NatTableId (string) –
  • RouterId (string) –
  • RouterName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • AssociationId (string) –
    • RequestId (string) –

nifty_associate_route_table_with_vpn_gateway(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_associate_route_table_with_vpn_gateway(
    Agreement=True|False,
    NiftyVpnGatewayName='string',
    RouteTableId='string',
    VpnGatewayId='string'
)
Parameters:
  • Agreement (boolean) –
  • NiftyVpnGatewayName (string) –
  • RouteTableId (string) –
  • VpnGatewayId (string) –
Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • AssociationId (string) –
    • RequestId (string) –

nifty_configure_elastic_load_balancer_health_check(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_configure_elastic_load_balancer_health_check(
    ElasticLoadBalancerId='string',
    ElasticLoadBalancerName='string',
    ElasticLoadBalancerPort=123,
    HealthCheck={
        'Interval': 123,
        'Target': 'string',
        'UnhealthyThreshold': 123
    },
    InstancePort=123,
    Protocol='string'
)
Parameters:
  • ElasticLoadBalancerId (string) –
  • ElasticLoadBalancerName (string) –
  • ElasticLoadBalancerPort (integer) –
  • HealthCheck (dict) –
    • Interval (integer) –
    • Target (string) –
    • UnhealthyThreshold (integer) –
  • InstancePort (integer) –
  • Protocol (string) –
Return type:

dict

Returns:

Response Syntax

{
    'HealthCheck': {
        'HealthyThreshold': 123,
        'InstanceStates': [
            {
                'Description': 'string',
                'InstanceId': 'string',
                'InstanceUniqueId': 'string',
                'ReasonCode': 'string',
                'State': 'string'
            },
        ],
        'Interval': 123,
        'Target': 'string',
        'Timeout': 123,
        'UnhealthyThreshold': 123
    },
    'NiftyConfigureElasticLoadBalancerHealthCheckResult': {'... recursive ...'},
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • HealthCheck (dict) –
      • HealthyThreshold (integer) –
      • InstanceStates (list) –
        • (dict) –
          • Description (string) –
          • InstanceId (string) –
          • InstanceUniqueId (string) –
          • ReasonCode (string) –
          • State (string) –
      • Interval (integer) –
      • Target (string) –
      • Timeout (integer) –
      • UnhealthyThreshold (integer) –
    • NiftyConfigureElasticLoadBalancerHealthCheckResult (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

nifty_create_alarm(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_alarm(
    AlarmCondition='string',
    Description='string',
    ElasticLoadBalancerName=[
        'string',
    ],
    ElasticLoadBalancerPort=[
        123,
    ],
    ElasticLoadBalancerProtocol=[
        'string',
    ],
    EmailAddress=[
        'string',
    ],
    FunctionName='string',
    InstanceId=[
        'string',
    ],
    LoadBalancerName=[
        'string',
    ],
    LoadBalancerPort=[
        123,
    ],
    Partition=[
        'string',
    ],
    Rule=[
        {
            'BreachDuration': 123,
            'DataType': 'string',
            'FromDate': 'string',
            'FunctionName': 'string',
            'RuleName': 'string',
            'Threshold': 123.0,
            'ToDate': 'string',
            'UpperLowerCondition': 'string'
        },
    ],
    RuleName='string',
    Zone='string'
)
Parameters:
  • AlarmCondition (string) –
  • Description (string) –
  • ElasticLoadBalancerName (list) –
    • (string) –
  • ElasticLoadBalancerPort (list) –
    • (integer) –
  • ElasticLoadBalancerProtocol (list) –
    • (string) –
  • EmailAddress (list) –
    • (string) –
  • FunctionName (string) –
  • InstanceId (list) –
    • (string) –
  • LoadBalancerName (list) –
    • (string) –
  • LoadBalancerPort (list) –
    • (integer) –
  • Partition (list) –
    • (string) –
  • Rule (list) –
    • (dict) –
      • BreachDuration (integer) –
      • DataType (string) –
      • FromDate (string) –
      • FunctionName (string) –
      • RuleName (string) –
      • Threshold (float) –
      • ToDate (string) –
      • UpperLowerCondition (string) –
  • RuleName (string) –
  • Zone (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_create_auto_scaling_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_auto_scaling_group(
    AutoScalingGroupName='string',
    ChangeInCapacity=123,
    DefaultCooldown=123,
    Description='string',
    ImageId='string',
    InstanceLifecycleLimit=123,
    InstanceType='string',
    LoadBalancers=[
        {
            'InstancePort': 123,
            'LoadBalancerName': 'string',
            'LoadBalancerPort': 123,
            'Name': 'string'
        },
    ],
    MaxSize=123,
    MinSize=123,
    Scaleout=123,
    ScaleoutCondition='string',
    ScalingSchedule=[
        {
            'RequestDDayStruct': {
                'EndingDDay': 'string',
                'StartingDDay': 'string'
            },
            'RequestDayStruct': {
                'SetFriday': 'string',
                'SetMonday': 'string',
                'SetSaturday': 'string',
                'SetSunday': 'string',
                'SetThursday': 'string',
                'SetTuesday': 'string',
                'SetWednesday': 'string'
            },
            'RequestMonthStruct': {
                'EndingMonth': 'string',
                'StartingMonth': 'string'
            },
            'RequestTimeZoneStruct': {
                'EndingTimeZone': 'string',
                'StartingTimeZone': 'string'
            }
        },
    ],
    ScalingTrigger=[
        {
            'BreachDuration': 123,
            'Resource': 'string',
            'UpperThreshold': 123.0
        },
    ],
    SecurityGroup=[
        'string',
    ]
)
Parameters:
  • AutoScalingGroupName (string) –
  • ChangeInCapacity (integer) –
  • DefaultCooldown (integer) –
  • Description (string) –
  • ImageId (string) –
  • InstanceLifecycleLimit (integer) –
  • InstanceType (string) –
  • LoadBalancers (list) –
    • (dict) –
      • InstancePort (integer) –
      • LoadBalancerName (string) –
      • LoadBalancerPort (integer) –
      • Name (string) –
  • MaxSize (integer) –
  • MinSize (integer) –
  • Scaleout (integer) –
  • ScaleoutCondition (string) –
  • ScalingSchedule (list) –
    • (dict) –
      • RequestDDayStruct (dict) –
        • EndingDDay (string) –
        • StartingDDay (string) –
      • RequestDayStruct (dict) –
        • SetFriday (string) –
        • SetMonday (string) –
        • SetSaturday (string) –
        • SetSunday (string) –
        • SetThursday (string) –
        • SetTuesday (string) –
        • SetWednesday (string) –
      • RequestMonthStruct (dict) –
        • EndingMonth (string) –
        • StartingMonth (string) –
      • RequestTimeZoneStruct (dict) –
        • EndingTimeZone (string) –
        • StartingTimeZone (string) –
  • ScalingTrigger (list) –
    • (dict) –
      • BreachDuration (integer) –
      • Resource (string) –
      • UpperThreshold (float) –
  • SecurityGroup (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_create_dhcp_config()

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_dhcp_config()
Return type:dict
Returns:Response Syntax
{
    'DhcpConfig': {
        'DhcpConfigId': 'string',
        'IpAddressPoolsSet': [
            {
                'Description': 'string',
                'StartIpAddress': 'string',
                'StopIpAddress': 'string'
            },
        ],
        'StaticMappingsSet': [
            {
                'Description': 'string',
                'IpAddress': 'string',
                'MacAddress': 'string'
            },
        ]
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • DhcpConfig (dict) –
      • DhcpConfigId (string) –
      • IpAddressPoolsSet (list) –
        • (dict) –
          • Description (string) –
          • StartIpAddress (string) –
          • StopIpAddress (string) –
      • StaticMappingsSet (list) –
        • (dict) –
          • Description (string) –
          • IpAddress (string) –
          • MacAddress (string) –
    • RequestId (string) –
nifty_create_dhcp_ip_address_pool(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_dhcp_ip_address_pool(
    Description='string',
    DhcpConfigId='string',
    StartIpAddress='string',
    StopIpAddress='string'
)
Parameters:
  • Description (string) –
  • DhcpConfigId (string) –
  • StartIpAddress (string) –
  • StopIpAddress (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_create_dhcp_static_mapping(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_dhcp_static_mapping(
    Description='string',
    DhcpConfigId='string',
    IpAddress='string',
    MacAddress='string'
)
Parameters:
  • Description (string) –
  • DhcpConfigId (string) –
  • IpAddress (string) –
  • MacAddress (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_create_elastic_load_balancer(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_elastic_load_balancer(
    AccountingType='string',
    AvailabilityZones=[
        'string',
    ],
    ElasticLoadBalancerName='string',
    Listeners=[
        {
            'BalancingType': 'string',
            'Description': 'string',
            'ElasticLoadBalancerPort': 123,
            'InstancePort': 123,
            'LoadBalancerPort': 123,
            'Protocol': 'string',
            'RequestHealthCheckStruct': {
                'Interval': 123,
                'Target': 'string',
                'UnhealthyThreshold': 123
            },
            'RequestInstances': [
                {
                    'InstanceId': 'string',
                    'InstanceUniqueId': 'string'
                },
            ],
            'RequestSessionStruct': {
                'RequestStickinessPolicyStruct': {
                    'Enable': True|False,
                    'ExpirationPeriod': 123,
                    'Method': 'string'
                }
            },
            'RequestSorryPageStruct': {
                'Enable': True|False,
                'RedirectUrl': 'string'
            },
            'SSLCertificateId': 'string'
        },
    ],
    NetworkInterface=[
        {
            'DeviceIndex': 123,
            'Dhcp': True|False,
            'DhcpConfigId': 'string',
            'DhcpOptionsId': 'string',
            'IpAddress': 'string',
            'IsVipNetwork': True|False,
            'NetworkId': 'string',
            'NetworkName': 'string',
            'RequestSecurityGroupId': [
                'string',
            ]
        },
    ],
    NetworkVolume=123
)
Parameters:
  • AccountingType (string) –
  • AvailabilityZones (list) –
    • (string) –
  • ElasticLoadBalancerName (string) –
  • Listeners (list) –
    • (dict) –
      • BalancingType (string) –
      • Description (string) –
      • ElasticLoadBalancerPort (integer) –
      • InstancePort (integer) –
      • LoadBalancerPort (integer) –
      • Protocol (string) –
      • RequestHealthCheckStruct (dict) –
        • Interval (integer) –
        • Target (string) –
        • UnhealthyThreshold (integer) –
      • RequestInstances (list) –
        • (dict) –
          • InstanceId (string) –
          • InstanceUniqueId (string) –
      • RequestSessionStruct (dict) –
        • RequestStickinessPolicyStruct (dict) –
          • Enable (boolean) –
          • ExpirationPeriod (integer) –
          • Method (string) –
      • RequestSorryPageStruct (dict) –
        • Enable (boolean) –
        • RedirectUrl (string) –
      • SSLCertificateId (string) –
  • NetworkInterface (list) –
    • (dict) –
      • DeviceIndex (integer) –
      • Dhcp (boolean) –
      • DhcpConfigId (string) –
      • DhcpOptionsId (string) –
      • IpAddress (string) –
      • IsVipNetwork (boolean) –
      • NetworkId (string) –
      • NetworkName (string) –
      • RequestSecurityGroupId (list) –
        • (string) –
  • NetworkVolume (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'DNSName': 'string',
    'NiftyCreateElasticLoadBalancerResult': {'... recursive ...'},
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • DNSName (string) –
    • NiftyCreateElasticLoadBalancerResult (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

nifty_create_instance_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_instance_snapshot(
    Description='string',
    InstanceId='string',
    SnapshotName='string'
)
Parameters:
  • Description (string) –
  • InstanceId (string) –
  • SnapshotName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'InstanceSet': [
        {
            'InstanceId': 'string',
            'InstanceState': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    'RequestId': 'string',
    'SnapshotName': 'string'
}

Response Structure

  • (dict) –
    • InstanceSet (list) –
      • (dict) –
        • InstanceId (string) –
        • InstanceState (string) –
        • InstanceUniqueId (string) –
    • RequestId (string) –
    • SnapshotName (string) –

nifty_create_nat_rule(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_nat_rule(
    Description='string',
    Destination={
        'Port': 123
    },
    InboundInterface={
        'NetworkId': 'string',
        'NetworkName': 'string'
    },
    NatTableId='string',
    NatType='string',
    OutboundInterface={
        'NetworkId': 'string',
        'NetworkName': 'string'
    },
    Protocol='string',
    RuleNumber='string',
    Source={
        'Address': 'string',
        'Port': 123
    },
    Translation={
        'Address': 'string',
        'Port': 123
    }
)
Parameters:
  • Description (string) –
  • Destination (dict) –
    • Port (integer) –
  • InboundInterface (dict) –
    • NetworkId (string) –
    • NetworkName (string) –
  • NatTableId (string) –
  • NatType (string) –
  • OutboundInterface (dict) –
    • NetworkId (string) –
    • NetworkName (string) –
  • Protocol (string) –
  • RuleNumber (string) –
  • Source (dict) –
    • Address (string) –
    • Port (integer) –
  • Translation (dict) –
    • Address (string) –
    • Port (integer) –
Return type:

dict

Returns:

Response Syntax

{
    'NatRule': {
        'Description': 'string',
        'Destination': {
            'Address': 'string',
            'Port': 123
        },
        'InboundInterface': {
            'NetworkId': 'string',
            'NetworkName': 'string'
        },
        'NatType': 'string',
        'OutboundInterface': {
            'NetworkId': 'string',
            'NetworkName': 'string'
        },
        'Protocol': 'string',
        'RuleNumber': 'string',
        'Source': {
            'Address': 'string',
            'Port': 123
        },
        'Translation': {
            'Address': 'string',
            'Port': 123
        }
    },
    'NatTableId': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • NatRule (dict) –
      • Description (string) –
      • Destination (dict) –
        • Address (string) –
        • Port (integer) –
      • InboundInterface (dict) –
        • NetworkId (string) –
        • NetworkName (string) –
      • NatType (string) –
      • OutboundInterface (dict) –
        • NetworkId (string) –
        • NetworkName (string) –
      • Protocol (string) –
      • RuleNumber (string) –
      • Source (dict) –
        • Address (string) –
        • Port (integer) –
      • Translation (dict) –
        • Address (string) –
        • Port (integer) –
    • NatTableId (string) –
    • RequestId (string) –

nifty_create_nat_table()

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_nat_table()
Return type:dict
Returns:Response Syntax
{
    'NatTable': {
        'NatTableId': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • NatTable (dict) –
      • NatTableId (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –
    • RequestId (string) –
nifty_create_private_lan(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_private_lan(
    AccountingType='string',
    AvailabilityZone='string',
    CidrBlock='string',
    Description='string',
    PrivateLanName='string'
)
Parameters:
  • AccountingType (string) –
  • AvailabilityZone (string) –
  • CidrBlock (string) –
  • Description (string) –
  • PrivateLanName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'PrivateLan': {
        'AccountingType': 'string',
        'AvailabilityZone': 'string',
        'Charge': 123,
        'CidrBlock': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'Description': 'string',
        'InstancesSet': [
            {
                'AccountingType': 'string',
                'Admin': 'string',
                'AmiLaunchIndex': 'string',
                'Architecture': 'string',
                'Autoscaling': {
                    'AutoScalingGroupName': 'string',
                    'ExpireTime': datetime(2015, 1, 1)
                },
                'BlockDeviceMapping': [
                    {
                        'DeviceName': 'string',
                        'Ebs': {
                            'AttachTime': datetime(2015, 1, 1),
                            'DeleteOnTermination': True|False,
                            'SnapshotId': 'string',
                            'Status': 'string',
                            'VolumeId': 'string',
                            'VolumeSize': 123
                        },
                        'NoDevice': 'string',
                        'VirtualName': 'string'
                    },
                ],
                'CopyInfo': 'string',
                'CurrentState': {
                    'Code': 123,
                    'Name': 'string'
                },
                'Description': 'string',
                'DeviceIndex': 123,
                'DnsName': 'string',
                'ExpireTime': datetime(2015, 1, 1),
                'HotAdd': 'string',
                'ImageId': 'string',
                'ImageName': 'string',
                'InstanceId': 'string',
                'InstanceLifecycle': 'string',
                'InstanceState': {
                    'Code': 123,
                    'Name': 'string'
                },
                'InstanceType': 'string',
                'InstanceUniqueId': 'string',
                'IpAddress': 'string',
                'IpAddressV6': 'string',
                'IpType': 'string',
                'KernelId': 'string',
                'KeyName': 'string',
                'LaunchTime': datetime(2015, 1, 1),
                'Loadbalancing': [
                    {
                        'InstancePort': 123,
                        'LoadBalancerName': 'string',
                        'LoadBalancerPort': 123,
                        'State': 'string'
                    },
                ],
                'Monitoring': {
                    'State': 'string'
                },
                'NetworkInterfaceSet': [
                    {
                        'Association': {
                            'IpOwnerId': 'string',
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'PublicIpV6': 'string'
                        },
                        'Attachment': {
                            'AttachTime': datetime(2015, 1, 1),
                            'AttachmentID': 'string',
                            'DeleteOnTermination': True|False,
                            'DeviceIndex': 123,
                            'Status': 'string'
                        },
                        'CidrBlock': 'string',
                        'Descriprion': 'string',
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Dhcp': True|False,
                        'DhcpOptionsId': 'string',
                        'GroupSet': [
                            {
                                'GroupId': 'string'
                            },
                        ],
                        'IpAddress': 'string',
                        'MacAddress': 'string',
                        'NetworkId': 'string',
                        'NetworkInterfaceId': 'string',
                        'NetworkName': 'string',
                        'NiftyNetworkId': 'string',
                        'NiftyNetworkName': 'string',
                        'OwnerId': 'string',
                        'PrivateDnsName': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddressV6': 'string',
                        'PrivateIpAddressesSet': [
                            {
                                'Association': {
                                    'IpOwnerId': 'string',
                                    'PublicDnsName': 'string',
                                    'PublicIp': 'string',
                                    'PublicIpV6': 'string'
                                },
                                'Primary': True|False,
                                'PrivateDnsName': 'string',
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SourceDestCheck': 'string',
                        'Status': 'string',
                        'SubnetId': 'string',
                        'VpcId': 'string'
                    },
                ],
                'NextMonthAccountingType': 'string',
                'NiftyElasticLoadBalancing': [
                    {
                        'ElasticLoadBalancerId': 'string',
                        'ElasticLoadBalancerName': 'string',
                        'ElasticLoadBalancerPort': 123,
                        'InstancePort': 123,
                        'Protocol': 'string'
                    },
                ],
                'NiftyPrivateIpType': 'string',
                'NiftyPrivateNetworkType': 'string',
                'NiftySnapshotting': [
                    {
                        'State': 'string'
                    },
                ],
                'Placement': {
                    'AvailabilityZone': 'string',
                    'RegionName': 'string'
                },
                'Platform': 'string',
                'PreviousState': {
                    'Code': 123,
                    'Name': 'string'
                },
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddressV6': 'string',
                'ProductCodes': [
                    {
                        'ProductCode': 'string'
                    },
                ],
                'RamdiskId': 'string',
                'Reason': 'string',
                'RegionName': 'string',
                'RootDeviceName': 'string',
                'RootDeviceType': 'string',
                'SpotInstanceRequestId': 'string',
                'StateReason': {
                    'Code': 123,
                    'Message': 'string'
                },
                'SubnetId': 'string',
                'Tenancy': 'string',
                'VpcId': 'string'
            },
        ],
        'PrivateLanId': 'string',
        'PrivateLanName': 'string',
        'RouterSet': [
            {
                'AccountingType': 'string',
                'AvailabilityZone': 'string',
                'CreatedTime': datetime(2015, 1, 1),
                'Description': 'string',
                'DeviceIndex': 123,
                'GroupSet': [
                    {
                        'GroupId': 'string'
                    },
                ],
                'IpAddress': 'string',
                'NatTableAssociationId': 'string',
                'NatTableId': 'string',
                'NetworkInterfaceSet': [
                    {
                        'Association': {
                            'IpOwnerId': 'string',
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'PublicIpV6': 'string'
                        },
                        'Attachment': {
                            'AttachTime': datetime(2015, 1, 1),
                            'AttachmentID': 'string',
                            'DeleteOnTermination': True|False,
                            'DeviceIndex': 123,
                            'Status': 'string'
                        },
                        'CidrBlock': 'string',
                        'Descriprion': 'string',
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Dhcp': True|False,
                        'DhcpOptionsId': 'string',
                        'GroupSet': [
                            {
                                'GroupId': 'string'
                            },
                        ],
                        'IpAddress': 'string',
                        'MacAddress': 'string',
                        'NetworkId': 'string',
                        'NetworkInterfaceId': 'string',
                        'NetworkName': 'string',
                        'NiftyNetworkId': 'string',
                        'NiftyNetworkName': 'string',
                        'OwnerId': 'string',
                        'PrivateDnsName': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddressV6': 'string',
                        'PrivateIpAddressesSet': [
                            {
                                'Association': {
                                    'IpOwnerId': 'string',
                                    'PublicDnsName': 'string',
                                    'PublicIp': 'string',
                                    'PublicIpV6': 'string'
                                },
                                'Primary': True|False,
                                'PrivateDnsName': 'string',
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SourceDestCheck': 'string',
                        'Status': 'string',
                        'SubnetId': 'string',
                        'VpcId': 'string'
                    },
                ],
                'NextMonthAccountingType': 'string',
                'RouteTableAssociationId': 'string',
                'RouteTableId': 'string',
                'RouterId': 'string',
                'RouterName': 'string',
                'State': 'string',
                'TagSet': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'Type': 'string'
            },
        ],
        'State': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string',
        'Unit': 'string',
        'Value': 123,
        'VpnGatewaySet': [
            {
                'AccountingType': 'string',
                'Attachments': [
                    {
                        'State': 'string',
                        'VpcId': 'string'
                    },
                ],
                'AvailabilityZone': 'string',
                'BackupInformation': {
                    'ExpirationDate': datetime(2015, 1, 1),
                    'IsBackup': True|False
                },
                'CreatedTime': datetime(2015, 1, 1),
                'DeviceIndex': 123,
                'GroupSet': [
                    {
                        'GroupId': 'string'
                    },
                ],
                'IpAddress': 'string',
                'NetworkInterfaceSet': [
                    {
                        'Association': {
                            'IpOwnerId': 'string',
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'PublicIpV6': 'string'
                        },
                        'Attachment': {
                            'AttachTime': datetime(2015, 1, 1),
                            'AttachmentID': 'string',
                            'DeleteOnTermination': True|False,
                            'DeviceIndex': 123,
                            'Status': 'string'
                        },
                        'CidrBlock': 'string',
                        'Descriprion': 'string',
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Dhcp': True|False,
                        'DhcpOptionsId': 'string',
                        'GroupSet': [
                            {
                                'GroupId': 'string'
                            },
                        ],
                        'IpAddress': 'string',
                        'MacAddress': 'string',
                        'NetworkId': 'string',
                        'NetworkInterfaceId': 'string',
                        'NetworkName': 'string',
                        'NiftyNetworkId': 'string',
                        'NiftyNetworkName': 'string',
                        'OwnerId': 'string',
                        'PrivateDnsName': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddressV6': 'string',
                        'PrivateIpAddressesSet': [
                            {
                                'Association': {
                                    'IpOwnerId': 'string',
                                    'PublicDnsName': 'string',
                                    'PublicIp': 'string',
                                    'PublicIpV6': 'string'
                                },
                                'Primary': True|False,
                                'PrivateDnsName': 'string',
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SourceDestCheck': 'string',
                        'Status': 'string',
                        'SubnetId': 'string',
                        'VpcId': 'string'
                    },
                ],
                'NiftyRedundancy': True|False,
                'NiftyVpnGatewayDescription': 'string',
                'NiftyVpnGatewayName': 'string',
                'NiftyVpnGatewayType': 'string',
                'RouteTableAssociationId': 'string',
                'RouteTableId': 'string',
                'State': 'string',
                'TagSet': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'Type': 'string',
                'VersionInformation': {
                    'IsLatest': True|False,
                    'Version': 'string'
                },
                'VpnGatewayId': 'string'
            },
        ]
    },
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • PrivateLan (dict) –
      • AccountingType (string) –
      • AvailabilityZone (string) –
      • Charge (integer) –
      • CidrBlock (string) –
      • CreatedTime (datetime) –
      • Description (string) –
      • InstancesSet (list) –
        • (dict) –
          • AccountingType (string) –
          • Admin (string) –
          • AmiLaunchIndex (string) –
          • Architecture (string) –
          • Autoscaling (dict) –
            • AutoScalingGroupName (string) –
            • ExpireTime (datetime) –
          • BlockDeviceMapping (list) –
            • (dict) –
              • DeviceName (string) –
              • Ebs (dict) –
                • AttachTime (datetime) –
                • DeleteOnTermination (boolean) –
                • SnapshotId (string) –
                • Status (string) –
                • VolumeId (string) –
                • VolumeSize (integer) –
              • NoDevice (string) –
              • VirtualName (string) –
          • CopyInfo (string) –
          • CurrentState (dict) –
            • Code (integer) –
            • Name (string) –
          • Description (string) –
          • DeviceIndex (integer) –
          • DnsName (string) –
          • ExpireTime (datetime) –
          • HotAdd (string) –
          • ImageId (string) –
          • ImageName (string) –
          • InstanceId (string) –
          • InstanceLifecycle (string) –
          • InstanceState (dict) –
            • Code (integer) –
            • Name (string) –
          • InstanceType (string) –
          • InstanceUniqueId (string) –
          • IpAddress (string) –
          • IpAddressV6 (string) –
          • IpType (string) –
          • KernelId (string) –
          • KeyName (string) –
          • LaunchTime (datetime) –
          • Loadbalancing (list) –
            • (dict) –
              • InstancePort (integer) –
              • LoadBalancerName (string) –
              • LoadBalancerPort (integer) –
              • State (string) –
          • Monitoring (dict) –
            • State (string) –
          • NetworkInterfaceSet (list) –
            • (dict) –
              • Association (dict) –
                • IpOwnerId (string) –
                • PublicDnsName (string) –
                • PublicIp (string) –
                • PublicIpV6 (string) –
              • Attachment (dict) –
                • AttachTime (datetime) –
                • AttachmentID (string) –
                • DeleteOnTermination (boolean) –
                • DeviceIndex (integer) –
                • Status (string) –
              • CidrBlock (string) –
              • Descriprion (string) –
              • Description (string) –
              • DeviceIndex (integer) –
              • Dhcp (boolean) –
              • DhcpOptionsId (string) –
              • GroupSet (list) –
                • (dict) –
                  • GroupId (string) –
              • IpAddress (string) –
              • MacAddress (string) –
              • NetworkId (string) –
              • NetworkInterfaceId (string) –
              • NetworkName (string) –
              • NiftyNetworkId (string) –
              • NiftyNetworkName (string) –
              • OwnerId (string) –
              • PrivateDnsName (string) –
              • PrivateIpAddress (string) –
              • PrivateIpAddressV6 (string) –
              • PrivateIpAddressesSet (list) –
                • (dict) –
                  • Association (dict) –
                    • IpOwnerId (string) –
                    • PublicDnsName (string) –
                    • PublicIp (string) –
                    • PublicIpV6 (string) –
                  • Primary (boolean) –
                  • PrivateDnsName (string) –
                  • PrivateIpAddress (string) –
              • SourceDestCheck (string) –
              • Status (string) –
              • SubnetId (string) –
              • VpcId (string) –
          • NextMonthAccountingType (string) –
          • NiftyElasticLoadBalancing (list) –
            • (dict) –
              • ElasticLoadBalancerId (string) –
              • ElasticLoadBalancerName (string) –
              • ElasticLoadBalancerPort (integer) –
              • InstancePort (integer) –
              • Protocol (string) –
          • NiftyPrivateIpType (string) –
          • NiftyPrivateNetworkType (string) –
          • NiftySnapshotting (list) –
            • (dict) –
              • State (string) –
          • Placement (dict) –
            • AvailabilityZone (string) –
            • RegionName (string) –
          • Platform (string) –
          • PreviousState (dict) –
            • Code (integer) –
            • Name (string) –
          • PrivateDnsName (string) –
          • PrivateIpAddress (string) –
          • PrivateIpAddressV6 (string) –
          • ProductCodes (list) –
            • (dict) –
              • ProductCode (string) –
          • RamdiskId (string) –
          • Reason (string) –
          • RegionName (string) –
          • RootDeviceName (string) –
          • RootDeviceType (string) –
          • SpotInstanceRequestId (string) –
          • StateReason (dict) –
            • Code (integer) –
            • Message (string) –
          • SubnetId (string) –
          • Tenancy (string) –
          • VpcId (string) –
      • PrivateLanId (string) –
      • PrivateLanName (string) –
      • RouterSet (list) –
        • (dict) –
          • AccountingType (string) –
          • AvailabilityZone (string) –
          • CreatedTime (datetime) –
          • Description (string) –
          • DeviceIndex (integer) –
          • GroupSet (list) –
            • (dict) –
              • GroupId (string) –
          • IpAddress (string) –
          • NatTableAssociationId (string) –
          • NatTableId (string) –
          • NetworkInterfaceSet (list) –
            • (dict) –
              • Association (dict) –
                • IpOwnerId (string) –
                • PublicDnsName (string) –
                • PublicIp (string) –
                • PublicIpV6 (string) –
              • Attachment (dict) –
                • AttachTime (datetime) –
                • AttachmentID (string) –
                • DeleteOnTermination (boolean) –
                • DeviceIndex (integer) –
                • Status (string) –
              • CidrBlock (string) –
              • Descriprion (string) –
              • Description (string) –
              • DeviceIndex (integer) –
              • Dhcp (boolean) –
              • DhcpOptionsId (string) –
              • GroupSet (list) –
                • (dict) –
                  • GroupId (string) –
              • IpAddress (string) –
              • MacAddress (string) –
              • NetworkId (string) –
              • NetworkInterfaceId (string) –
              • NetworkName (string) –
              • NiftyNetworkId (string) –
              • NiftyNetworkName (string) –
              • OwnerId (string) –
              • PrivateDnsName (string) –
              • PrivateIpAddress (string) –
              • PrivateIpAddressV6 (string) –
              • PrivateIpAddressesSet (list) –
                • (dict) –
                  • Association (dict) –
                    • IpOwnerId (string) –
                    • PublicDnsName (string) –
                    • PublicIp (string) –
                    • PublicIpV6 (string) –
                  • Primary (boolean) –
                  • PrivateDnsName (string) –
                  • PrivateIpAddress (string) –
              • SourceDestCheck (string) –
              • Status (string) –
              • SubnetId (string) –
              • VpcId (string) –
          • NextMonthAccountingType (string) –
          • RouteTableAssociationId (string) –
          • RouteTableId (string) –
          • RouterId (string) –
          • RouterName (string) –
          • State (string) –
          • TagSet (list) –
            • (dict) –
              • Key (string) –
              • Value (string) –
          • Type (string) –
      • State (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –
      • Type (string) –
      • Unit (string) –
      • Value (integer) –
      • VpnGatewaySet (list) –
        • (dict) –
          • AccountingType (string) –
          • Attachments (list) –
            • (dict) –
              • State (string) –
              • VpcId (string) –
          • AvailabilityZone (string) –
          • BackupInformation (dict) –
            • ExpirationDate (datetime) –
            • IsBackup (boolean) –
          • CreatedTime (datetime) –
          • DeviceIndex (integer) –
          • GroupSet (list) –
            • (dict) –
              • GroupId (string) –
          • IpAddress (string) –
          • NetworkInterfaceSet (list) –
            • (dict) –
              • Association (dict) –
                • IpOwnerId (string) –
                • PublicDnsName (string) –
                • PublicIp (string) –
                • PublicIpV6 (string) –
              • Attachment (dict) –
                • AttachTime (datetime) –
                • AttachmentID (string) –
                • DeleteOnTermination (boolean) –
                • DeviceIndex (integer) –
                • Status (string) –
              • CidrBlock (string) –
              • Descriprion (string) –
              • Description (string) –
              • DeviceIndex (integer) –
              • Dhcp (boolean) –
              • DhcpOptionsId (string) –
              • GroupSet (list) –
                • (dict) –
                  • GroupId (string) –
              • IpAddress (string) –
              • MacAddress (string) –
              • NetworkId (string) –
              • NetworkInterfaceId (string) –
              • NetworkName (string) –
              • NiftyNetworkId (string) –
              • NiftyNetworkName (string) –
              • OwnerId (string) –
              • PrivateDnsName (string) –
              • PrivateIpAddress (string) –
              • PrivateIpAddressV6 (string) –
              • PrivateIpAddressesSet (list) –
                • (dict) –
                  • Association (dict) –
                    • IpOwnerId (string) –
                    • PublicDnsName (string) –
                    • PublicIp (string) –
                    • PublicIpV6 (string) –
                  • Primary (boolean) –
                  • PrivateDnsName (string) –
                  • PrivateIpAddress (string) –
              • SourceDestCheck (string) –
              • Status (string) –
              • SubnetId (string) –
              • VpcId (string) –
          • NiftyRedundancy (boolean) –
          • NiftyVpnGatewayDescription (string) –
          • NiftyVpnGatewayName (string) –
          • NiftyVpnGatewayType (string) –
          • RouteTableAssociationId (string) –
          • RouteTableId (string) –
          • State (string) –
          • TagSet (list) –
            • (dict) –
              • Key (string) –
              • Value (string) –
          • Type (string) –
          • VersionInformation (dict) –
            • IsLatest (boolean) –
            • Version (string) –
          • VpnGatewayId (string) –
    • RequestId (string) –

nifty_create_router(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_router(
    AccountingType='string',
    AvailabilityZone='string',
    Description='string',
    NetworkInterface=[
        {
            'DeviceIndex': 123,
            'Dhcp': True|False,
            'DhcpConfigId': 'string',
            'DhcpOptionsId': 'string',
            'IpAddress': 'string',
            'IsVipNetwork': True|False,
            'NetworkId': 'string',
            'NetworkName': 'string',
            'RequestSecurityGroupId': [
                'string',
            ]
        },
    ],
    RouterName='string',
    SecurityGroup=[
        'string',
    ],
    Type='string'
)
Parameters:
  • AccountingType (string) –
  • AvailabilityZone (string) –
  • Description (string) –
  • NetworkInterface (list) –
    • (dict) –
      • DeviceIndex (integer) –
      • Dhcp (boolean) –
      • DhcpConfigId (string) –
      • DhcpOptionsId (string) –
      • IpAddress (string) –
      • IsVipNetwork (boolean) –
      • NetworkId (string) –
      • NetworkName (string) –
      • RequestSecurityGroupId (list) –
        • (string) –
  • RouterName (string) –
  • SecurityGroup (list) –
    • (string) –
  • Type (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Router': {
        'AccountingType': 'string',
        'AvailabilityZone': 'string',
        'BackupInformation': {
            'ExpirationDate': datetime(2015, 1, 1),
            'IsBackup': True|False
        },
        'CreatedTime': datetime(2015, 1, 1),
        'Description': 'string',
        'NatTableAssociationId': 'string',
        'NatTableId': 'string',
        'NetworkInterfaceSet': [
            {
                'Association': {
                    'IpOwnerId': 'string',
                    'PublicDnsName': 'string',
                    'PublicIp': 'string',
                    'PublicIpV6': 'string'
                },
                'Attachment': {
                    'AttachTime': datetime(2015, 1, 1),
                    'AttachmentID': 'string',
                    'DeleteOnTermination': True|False,
                    'DeviceIndex': 123,
                    'Status': 'string'
                },
                'CidrBlock': 'string',
                'Descriprion': 'string',
                'Description': 'string',
                'DeviceIndex': 123,
                'Dhcp': True|False,
                'DhcpOptionsId': 'string',
                'GroupSet': [
                    {
                        'GroupId': 'string'
                    },
                ],
                'IpAddress': 'string',
                'MacAddress': 'string',
                'NetworkId': 'string',
                'NetworkInterfaceId': 'string',
                'NetworkName': 'string',
                'NiftyNetworkId': 'string',
                'NiftyNetworkName': 'string',
                'OwnerId': 'string',
                'PrivateDnsName': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddressV6': 'string',
                'PrivateIpAddressesSet': [
                    {
                        'Association': {
                            'IpOwnerId': 'string',
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'PublicIpV6': 'string'
                        },
                        'Primary': True|False,
                        'PrivateDnsName': 'string',
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SourceDestCheck': 'string',
                'Status': 'string',
                'SubnetId': 'string',
                'VpcId': 'string'
            },
        ],
        'NextMonthAccountingType': 'string',
        'RouteTableAssociationId': 'string',
        'RouteTableId': 'string',
        'RouterId': 'string',
        'RouterName': 'string',
        'State': 'string',
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'Type': 'string',
        'VersionInformation': {
            'IsLatest': True|False,
            'Version': 'string'
        }
    }
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Router (dict) –
      • AccountingType (string) –
      • AvailabilityZone (string) –
      • BackupInformation (dict) –
        • ExpirationDate (datetime) –
        • IsBackup (boolean) –
      • CreatedTime (datetime) –
      • Description (string) –
      • NatTableAssociationId (string) –
      • NatTableId (string) –
      • NetworkInterfaceSet (list) –
        • (dict) –
          • Association (dict) –
            • IpOwnerId (string) –
            • PublicDnsName (string) –
            • PublicIp (string) –
            • PublicIpV6 (string) –
          • Attachment (dict) –
            • AttachTime (datetime) –
            • AttachmentID (string) –
            • DeleteOnTermination (boolean) –
            • DeviceIndex (integer) –
            • Status (string) –
          • CidrBlock (string) –
          • Descriprion (string) –
          • Description (string) –
          • DeviceIndex (integer) –
          • Dhcp (boolean) –
          • DhcpOptionsId (string) –
          • GroupSet (list) –
            • (dict) –
              • GroupId (string) –
          • IpAddress (string) –
          • MacAddress (string) –
          • NetworkId (string) –
          • NetworkInterfaceId (string) –
          • NetworkName (string) –
          • NiftyNetworkId (string) –
          • NiftyNetworkName (string) –
          • OwnerId (string) –
          • PrivateDnsName (string) –
          • PrivateIpAddress (string) –
          • PrivateIpAddressV6 (string) –
          • PrivateIpAddressesSet (list) –
            • (dict) –
              • Association (dict) –
                • IpOwnerId (string) –
                • PublicDnsName (string) –
                • PublicIp (string) –
                • PublicIpV6 (string) –
              • Primary (boolean) –
              • PrivateDnsName (string) –
              • PrivateIpAddress (string) –
          • SourceDestCheck (string) –
          • Status (string) –
          • SubnetId (string) –
          • VpcId (string) –
      • NextMonthAccountingType (string) –
      • RouteTableAssociationId (string) –
      • RouteTableId (string) –
      • RouterId (string) –
      • RouterName (string) –
      • State (string) –
      • TagSet (list) –
        • (dict) –
          • Key (string) –
          • Value (string) –
      • Type (string) –
      • VersionInformation (dict) –
        • IsLatest (boolean) –
        • Version (string) –

nifty_create_separate_instance_rule(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_separate_instance_rule(
    InstanceId=[
        'string',
    ],
    InstanceUniqueId=[
        'string',
    ],
    Placement={
        'AvailabilityZone': 'string',
        'RegionName': 'string'
    },
    SeparateInstanceRuleDescription='string',
    SeparateInstanceRuleName='string'
)
Parameters:
  • InstanceId (list) –
    • (string) –
  • InstanceUniqueId (list) –
    • (string) –
  • Placement (dict) –
    • AvailabilityZone (string) –
    • RegionName (string) –
  • SeparateInstanceRuleDescription (string) –
  • SeparateInstanceRuleName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': 'string'
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (string) –

nifty_create_web_proxy(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_create_web_proxy(
    Agreement=True|False,
    BypassInterface={
        'NetworkId': 'string',
        'NetworkName': 'string'
    },
    Description='string',
    ListenInterface={
        'NetworkId': 'string',
        'NetworkName': 'string'
    },
    ListenPort='string',
    Option={
        'NameServer': 'string'
    },
    RouterId='string',
    RouterName='string'
)
Parameters:
  • Agreement (boolean) –
  • BypassInterface (dict) –
    • NetworkId (string) –
    • NetworkName (string) –
  • Description (string) –
  • ListenInterface (dict) –
    • NetworkId (string) –
    • NetworkName (string) –
  • ListenPort (string) –
  • Option (dict) –
    • NameServer (string) –
  • RouterId (string) –
  • RouterName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'WebProxy': {
        'BypassInterface': {
            'NetworkId': 'string',
            'NetworkName': 'string'
        },
        'Description': 'string',
        'ListenInterface': {
            'NetworkId': 'string',
            'NetworkName': 'string'
        },
        'ListenPort': 'string',
        'Option': {
            'MobileFilter': {
                'Enabled': True|False
            },
            'NameServer': 'string',
            'SessionStickinessPolicy': {
                'Enabled': True|False,
                'ExpirationPeriod': 123,
                'Method': 123
            },
            'SorryPage': {
                'Enabled': True|False,
                'RedirectUrl': 'string',
                'StatusCode': 123
            }
        },
        'RouterId': 'string',
        'RouterName': 'string'
    }
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • WebProxy (dict) –
      • BypassInterface (dict) –
        • NetworkId (string) –
        • NetworkName (string) –
      • Description (string) –
      • ListenInterface (dict) –
        • NetworkId (string) –
        • NetworkName (string) –
      • ListenPort (string) –
      • Option (dict) –
        • MobileFilter (dict) –
          • Enabled (boolean) –
        • NameServer (string) –
        • SessionStickinessPolicy (dict) –
          • Enabled (boolean) –
          • ExpirationPeriod (integer) –
          • Method (integer) –
        • SorryPage (dict) –
          • Enabled (boolean) –
          • RedirectUrl (string) –
          • StatusCode (integer) –
      • RouterId (string) –
      • RouterName (string) –

nifty_delete_alarm(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_alarm(
    FunctionName='string',
    RuleName='string'
)
Parameters:
  • FunctionName (string) –
  • RuleName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_delete_auto_scaling_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_auto_scaling_group(
    AutoScalingGroupName='string'
)
Parameters:AutoScalingGroupName (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
nifty_delete_dhcp_config(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_dhcp_config(
    DhcpConfigId='string'
)
Parameters:DhcpConfigId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
nifty_delete_dhcp_ip_address_pool(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_dhcp_ip_address_pool(
    DhcpConfigId='string',
    StartIpAddress='string',
    StopIpAddress='string'
)
Parameters:
  • DhcpConfigId (string) –
  • StartIpAddress (string) –
  • StopIpAddress (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_delete_dhcp_static_mapping(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_dhcp_static_mapping(
    DhcpConfigId='string',
    IpAddress='string',
    MacAddress='string'
)
Parameters:
  • DhcpConfigId (string) –
  • IpAddress (string) –
  • MacAddress (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_delete_elastic_load_balancer(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_elastic_load_balancer(
    ElasticLoadBalancerId='string',
    ElasticLoadBalancerName='string',
    ElasticLoadBalancerPort=123,
    InstancePort=123,
    Protocol='string'
)
Parameters:
  • ElasticLoadBalancerId (string) –
  • ElasticLoadBalancerName (string) –
  • ElasticLoadBalancerPort (integer) –
  • InstancePort (integer) –
  • Protocol (string) –
Return type:

dict

Returns:

Response Syntax

{
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

nifty_delete_instance_snapshot(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_instance_snapshot(
    InstanceSnapshotId=[
        'string',
    ],
    SnapshotName=[
        'string',
    ]
)
Parameters:
  • InstanceSnapshotId (list) –
    • (string) –
  • SnapshotName (list) –
    • (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'SnapshotInfoSet': [
        {
            'CreatedTime': 'string',
            'ExpiredTime': 'string',
            'InstanceId': 'string',
            'InstanceSnapshotId': 'string',
            'Memo': 'string',
            'PowerStatus': 'string',
            'SnapshotName': 'string',
            'Status': 'string',
            'UpdatedTime': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • SnapshotInfoSet (list) –
      • (dict) –
        • CreatedTime (string) –
        • ExpiredTime (string) –
        • InstanceId (string) –
        • InstanceSnapshotId (string) –
        • Memo (string) –
        • PowerStatus (string) –
        • SnapshotName (string) –
        • Status (string) –
        • UpdatedTime (string) –

nifty_delete_nat_rule(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_nat_rule(
    NatTableId='string',
    NatType='string',
    RuleNumber='string'
)
Parameters:
  • NatTableId (string) –
  • NatType (string) –
  • RuleNumber (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_delete_nat_table(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_nat_table(
    NatTableId='string'
)
Parameters:NatTableId (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –
nifty_delete_private_lan(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_private_lan(
    NetworkId='string',
    PrivateLanName='string'
)
Parameters:
  • NetworkId (string) –
  • PrivateLanName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_delete_router(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_router(
    RouterId='string',
    RouterName='string'
)
Parameters:
  • RouterId (string) –
  • RouterName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_delete_separate_instance_rule(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_separate_instance_rule(
    SeparateInstanceRuleName='string'
)
Parameters:SeparateInstanceRuleName (string) –
Return type:dict
Returns:Response Syntax
{
    'RequestId': 'string',
    'Return': 'string'
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (string) –
nifty_delete_web_proxy(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_delete_web_proxy(
    Agreement=True|False,
    RouterId='string',
    RouterName='string'
)
Parameters:
  • Agreement (boolean) –
  • RouterId (string) –
  • RouterName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'Return': True|False
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • Return (boolean) –

nifty_deregister_instances_from_elastic_load_balancer(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_deregister_instances_from_elastic_load_balancer(
    ElasticLoadBalancerId='string',
    ElasticLoadBalancerName='string',
    ElasticLoadBalancerPort=123,
    InstancePort=123,
    Instances=[
        {
            'InstanceId': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    Protocol='string'
)
Parameters:
  • ElasticLoadBalancerId (string) –
  • ElasticLoadBalancerName (string) –
  • ElasticLoadBalancerPort (integer) –
  • InstancePort (integer) –
  • Instances (list) –
    • (dict) –
      • InstanceId (string) –
      • InstanceUniqueId (string) –
  • Protocol (string) –
Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'InstanceId': 'string',
            'InstanceUniqueId': 'string'
        },
    ],
    'NiftyDeregisterInstancesFromElasticLoadBalancerResult': {'... recursive ...'},
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –
    • Instances (list) –
      • (dict) –
        • InstanceId (string) –
        • InstanceUniqueId (string) –
    • NiftyDeregisterInstancesFromElasticLoadBalancerResult (dict) –
    • ResponseMetadata (dict) –
      • RequestId (string) –

nifty_deregister_instances_from_separate_instance_rule(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_deregister_instances_from_separate_instance_rule(
    InstanceId=[
        'string',
    ],
    InstanceUniqueId=[
        'string',
    ],
    SeparateInstanceRuleName='string'
)
Parameters:
  • InstanceId (list) –
    • (string) –
  • InstanceUniqueId (list) –
    • (string) –
  • SeparateInstanceRuleName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'InstancesSet': [
        {
            'AccountingType': 'string',
            'Admin': 'string',
            'AmiLaunchIndex': 'string',
            'Architecture': 'string',
            'Autoscaling': {
                'AutoScalingGroupName': 'string',
                'ExpireTime': datetime(2015, 1, 1)
            },
            'BlockDeviceMapping': [
                {
                    'DeviceName': 'string',
                    'Ebs': {
                        'AttachTime': datetime(2015, 1, 1),
                        'DeleteOnTermination': True|False,
                        'SnapshotId': 'string',
                        'Status': 'string',
                        'VolumeId': 'string',
                        'VolumeSize': 123
                    },
                    'NoDevice': 'string',
                    'VirtualName': 'string'
                },
            ],
            'CopyInfo': 'string',
            'CurrentState': {
                'Code': 123,
                'Name': 'string'
            },
            'Description': 'string',
            'DeviceIndex': 123,
            'DnsName': 'string',
            'ExpireTime': datetime(2015, 1, 1),
            'HotAdd': 'string',
            'ImageId': 'string',
            'ImageName': 'string',
            'InstanceId': 'string',
            'InstanceLifecycle': 'string',
            'InstanceState': {
                'Code': 123,
                'Name': 'string'
            },
            'InstanceType': 'string',
            'InstanceUniqueId': 'string',
            'IpAddress': 'string',
            'IpAddressV6': 'string',
            'IpType': 'string',
            'KernelId': 'string',
            'KeyName': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'Loadbalancing': [
                {
                    'InstancePort': 123,
                    'LoadBalancerName': 'string',
                    'LoadBalancerPort': 123,
                    'State': 'string'
                },
            ],
            'Monitoring': {
                'State': 'string'
            },
            'NetworkInterfaceSet': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'PublicIpV6': 'string'
                    },
                    'Attachment': {
                        'AttachTime': datetime(2015, 1, 1),
                        'AttachmentID': 'string',
                        'DeleteOnTermination': True|False,
                        'DeviceIndex': 123,
                        'Status': 'string'
                    },
                    'CidrBlock': 'string',
                    'Descriprion': 'string',
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'Dhcp': True|False,
                    'DhcpOptionsId': 'string',
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'MacAddress': 'string',
                    'NetworkId': 'string',
                    'NetworkInterfaceId': 'string',
                    'NetworkName': 'string',
                    'NiftyNetworkId': 'string',
                    'NiftyNetworkName': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'PrivateIpAddressesSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Primary': True|False,
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SourceDestCheck': 'string',
                    'Status': 'string',
                    'SubnetId': 'string',
                    'VpcId': 'string'
                },
            ],
            'NextMonthAccountingType': 'string',
            'NiftyElasticLoadBalancing': [
                {
                    'ElasticLoadBalancerId': 'string',
                    'ElasticLoadBalancerName': 'string',
                    'ElasticLoadBalancerPort': 123,
                    'InstancePort': 123,
                    'Protocol': 'string'
                },
            ],
            'NiftyPrivateIpType': 'string',
            'NiftyPrivateNetworkType': 'string',
            'NiftySnapshotting': [
                {
                    'State': 'string'
                },
            ],
            'Placement': {
                'AvailabilityZone': 'string',
                'RegionName': 'string'
            },
            'Platform': 'string',
            'PreviousState': {
                'Code': 123,
                'Name': 'string'
            },
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddressV6': 'string',
            'ProductCodes': [
                {
                    'ProductCode': 'string'
                },
            ],
            'RamdiskId': 'string',
            'Reason': 'string',
            'RegionName': 'string',
            'RootDeviceName': 'string',
            'RootDeviceType': 'string',
            'SpotInstanceRequestId': 'string',
            'StateReason': {
                'Code': 123,
                'Message': 'string'
            },
            'SubnetId': 'string',
            'Tenancy': 'string',
            'VpcId': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –
    • InstancesSet (list) –
      • (dict) –
        • AccountingType (string) –
        • Admin (string) –
        • AmiLaunchIndex (string) –
        • Architecture (string) –
        • Autoscaling (dict) –
          • AutoScalingGroupName (string) –
          • ExpireTime (datetime) –
        • BlockDeviceMapping (list) –
          • (dict) –
            • DeviceName (string) –
            • Ebs (dict) –
              • AttachTime (datetime) –
              • DeleteOnTermination (boolean) –
              • SnapshotId (string) –
              • Status (string) –
              • VolumeId (string) –
              • VolumeSize (integer) –
            • NoDevice (string) –
            • VirtualName (string) –
        • CopyInfo (string) –
        • CurrentState (dict) –
          • Code (integer) –
          • Name (string) –
        • Description (string) –
        • DeviceIndex (integer) –
        • DnsName (string) –
        • ExpireTime (datetime) –
        • HotAdd (string) –
        • ImageId (string) –
        • ImageName (string) –
        • InstanceId (string) –
        • InstanceLifecycle (string) –
        • InstanceState (dict) –
          • Code (integer) –
          • Name (string) –
        • InstanceType (string) –
        • InstanceUniqueId (string) –
        • IpAddress (string) –
        • IpAddressV6 (string) –
        • IpType (string) –
        • KernelId (string) –
        • KeyName (string) –
        • LaunchTime (datetime) –
        • Loadbalancing (list) –
          • (dict) –
            • InstancePort (integer) –
            • LoadBalancerName (string) –
            • LoadBalancerPort (integer) –
            • State (string) –
        • Monitoring (dict) –
          • State (string) –
        • NetworkInterfaceSet (list) –
          • (dict) –
            • Association (dict) –
              • IpOwnerId (string) –
              • PublicDnsName (string) –
              • PublicIp (string) –
              • PublicIpV6 (string) –
            • Attachment (dict) –
              • AttachTime (datetime) –
              • AttachmentID (string) –
              • DeleteOnTermination (boolean) –
              • DeviceIndex (integer) –
              • Status (string) –
            • CidrBlock (string) –
            • Descriprion (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • Dhcp (boolean) –
            • DhcpOptionsId (string) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • MacAddress (string) –
            • NetworkId (string) –
            • NetworkInterfaceId (string) –
            • NetworkName (string) –
            • NiftyNetworkId (string) –
            • NiftyNetworkName (string) –
            • OwnerId (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • PrivateIpAddressesSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Primary (boolean) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
            • SourceDestCheck (string) –
            • Status (string) –
            • SubnetId (string) –
            • VpcId (string) –
        • NextMonthAccountingType (string) –
        • NiftyElasticLoadBalancing (list) –
          • (dict) –
            • ElasticLoadBalancerId (string) –
            • ElasticLoadBalancerName (string) –
            • ElasticLoadBalancerPort (integer) –
            • InstancePort (integer) –
            • Protocol (string) –
        • NiftyPrivateIpType (string) –
        • NiftyPrivateNetworkType (string) –
        • NiftySnapshotting (list) –
          • (dict) –
            • State (string) –
        • Placement (dict) –
          • AvailabilityZone (string) –
          • RegionName (string) –
        • Platform (string) –
        • PreviousState (dict) –
          • Code (integer) –
          • Name (string) –
        • PrivateDnsName (string) –
        • PrivateIpAddress (string) –
        • PrivateIpAddressV6 (string) –
        • ProductCodes (list) –
          • (dict) –
            • ProductCode (string) –
        • RamdiskId (string) –
        • Reason (string) –
        • RegionName (string) –
        • RootDeviceName (string) –
        • RootDeviceType (string) –
        • SpotInstanceRequestId (string) –
        • StateReason (dict) –
          • Code (integer) –
          • Message (string) –
        • SubnetId (string) –
        • Tenancy (string) –
        • VpcId (string) –
    • RequestId (string) –

nifty_deregister_routers_from_security_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_deregister_routers_from_security_group(
    GroupName='string',
    RouterSet=[
        {
            'RouterId': 'string',
            'RouterName': 'string'
        },
    ]
)
Parameters:
  • GroupName (string) –
  • RouterSet (list) –
    • (dict) –
      • RouterId (string) –
      • RouterName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'RouterSet': [
        {
            'AccountingType': 'string',
            'AvailabilityZone': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'Description': 'string',
            'DeviceIndex': 123,
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'IpAddress': 'string',
            'NatTableAssociationId': 'string',
            'NatTableId': 'string',
            'NetworkInterfaceSet': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'PublicIpV6': 'string'
                    },
                    'Attachment': {
                        'AttachTime': datetime(2015, 1, 1),
                        'AttachmentID': 'string',
                        'DeleteOnTermination': True|False,
                        'DeviceIndex': 123,
                        'Status': 'string'
                    },
                    'CidrBlock': 'string',
                    'Descriprion': 'string',
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'Dhcp': True|False,
                    'DhcpOptionsId': 'string',
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'MacAddress': 'string',
                    'NetworkId': 'string',
                    'NetworkInterfaceId': 'string',
                    'NetworkName': 'string',
                    'NiftyNetworkId': 'string',
                    'NiftyNetworkName': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'PrivateIpAddressesSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Primary': True|False,
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SourceDestCheck': 'string',
                    'Status': 'string',
                    'SubnetId': 'string',
                    'VpcId': 'string'
                },
            ],
            'NextMonthAccountingType': 'string',
            'RouteTableAssociationId': 'string',
            'RouteTableId': 'string',
            'RouterId': 'string',
            'RouterName': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • RouterSet (list) –
      • (dict) –
        • AccountingType (string) –
        • AvailabilityZone (string) –
        • CreatedTime (datetime) –
        • Description (string) –
        • DeviceIndex (integer) –
        • GroupSet (list) –
          • (dict) –
            • GroupId (string) –
        • IpAddress (string) –
        • NatTableAssociationId (string) –
        • NatTableId (string) –
        • NetworkInterfaceSet (list) –
          • (dict) –
            • Association (dict) –
              • IpOwnerId (string) –
              • PublicDnsName (string) –
              • PublicIp (string) –
              • PublicIpV6 (string) –
            • Attachment (dict) –
              • AttachTime (datetime) –
              • AttachmentID (string) –
              • DeleteOnTermination (boolean) –
              • DeviceIndex (integer) –
              • Status (string) –
            • CidrBlock (string) –
            • Descriprion (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • Dhcp (boolean) –
            • DhcpOptionsId (string) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • MacAddress (string) –
            • NetworkId (string) –
            • NetworkInterfaceId (string) –
            • NetworkName (string) –
            • NiftyNetworkId (string) –
            • NiftyNetworkName (string) –
            • OwnerId (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • PrivateIpAddressesSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Primary (boolean) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
            • SourceDestCheck (string) –
            • Status (string) –
            • SubnetId (string) –
            • VpcId (string) –
        • NextMonthAccountingType (string) –
        • RouteTableAssociationId (string) –
        • RouteTableId (string) –
        • RouterId (string) –
        • RouterName (string) –
        • State (string) –
        • TagSet (list) –
          • (dict) –
            • Key (string) –
            • Value (string) –
        • Type (string) –

nifty_deregister_vpn_gateways_from_security_group(**kwargs)

See also: NIFCLOUD API Documentation

Request Syntax

response = client.nifty_deregister_vpn_gateways_from_security_group(
    GroupName='string',
    RouterSet=[
        {
            'RouterId': 'string',
            'RouterName': 'string'
        },
    ]
)
Parameters:
  • GroupName (string) –
  • RouterSet (list) –
    • (dict) –
      • RouterId (string) –
      • RouterName (string) –
Return type:

dict

Returns:

Response Syntax

{
    'RequestId': 'string',
    'VpnGatewaySet': [
        {
            'AccountingType': 'string',
            'Attachments': [
                {
                    'State': 'string',
                    'VpcId': 'string'
                },
            ],
            'AvailabilityZone': 'string',
            'BackupInformation': {
                'ExpirationDate': datetime(2015, 1, 1),
                'IsBackup': True|False
            },
            'CreatedTime': datetime(2015, 1, 1),
            'DeviceIndex': 123,
            'GroupSet': [
                {
                    'GroupId': 'string'
                },
            ],
            'IpAddress': 'string',
            'NetworkInterfaceSet': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string',
                        'PublicIpV6': 'string'
                    },
                    'Attachment': {
                        'AttachTime': datetime(2015, 1, 1),
                        'AttachmentID': 'string',
                        'DeleteOnTermination': True|False,
                        'DeviceIndex': 123,
                        'Status': 'string'
                    },
                    'CidrBlock': 'string',
                    'Descriprion': 'string',
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'Dhcp': True|False,
                    'DhcpOptionsId': 'string',
                    'GroupSet': [
                        {
                            'GroupId': 'string'
                        },
                    ],
                    'IpAddress': 'string',
                    'MacAddress': 'string',
                    'NetworkId': 'string',
                    'NetworkInterfaceId': 'string',
                    'NetworkName': 'string',
                    'NiftyNetworkId': 'string',
                    'NiftyNetworkName': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddressV6': 'string',
                    'PrivateIpAddressesSet': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string',
                                'PublicIpV6': 'string'
                            },
                            'Primary': True|False,
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SourceDestCheck': 'string',
                    'Status': 'string',
                    'SubnetId': 'string',
                    'VpcId': 'string'
                },
            ],
            'NiftyRedundancy': True|False,
            'NiftyVpnGatewayDescription': 'string',
            'NiftyVpnGatewayName': 'string',
            'NiftyVpnGatewayType': 'string',
            'RouteTableAssociationId': 'string',
            'RouteTableId': 'string',
            'State': 'string',
            'TagSet': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'string',
            'VersionInformation': {
                'IsLatest': True|False,
                'Version': 'string'
            },
            'VpnGatewayId': 'string'
        },
    ]
}

Response Structure

  • (dict) –
    • RequestId (string) –
    • VpnGatewaySet (list) –
      • (dict) –
        • AccountingType (string) –
        • Attachments (list) –
          • (dict) –
            • State (string) –
            • VpcId (string) –
        • AvailabilityZone (string) –
        • BackupInformation (dict) –
          • ExpirationDate (datetime) –
          • IsBackup (boolean) –
        • CreatedTime (datetime) –
        • DeviceIndex (integer) –
        • GroupSet (list) –
          • (dict) –
            • GroupId (string) –
        • IpAddress (string) –
        • NetworkInterfaceSet (list) –
          • (dict) –
            • Association (dict) –
              • IpOwnerId (string) –
              • PublicDnsName (string) –
              • PublicIp (string) –
              • PublicIpV6 (string) –
            • Attachment (dict) –
              • AttachTime (datetime) –
              • AttachmentID (string) –
              • DeleteOnTermination (boolean) –
              • DeviceIndex (integer) –
              • Status (string) –
            • CidrBlock (string) –
            • Descriprion (string) –
            • Description (string) –
            • DeviceIndex (integer) –
            • Dhcp (boolean) –
            • DhcpOptionsId (string) –
            • GroupSet (list) –
              • (dict) –
                • GroupId (string) –
            • IpAddress (string) –
            • MacAddress (string) –
            • NetworkId (string) –
            • NetworkInterfaceId (string) –
            • NetworkName (string) –
            • NiftyNetworkId (string) –
            • NiftyNetworkName (string) –
            • OwnerId (string) –
            • PrivateDnsName (string) –
            • PrivateIpAddress (string) –
            • PrivateIpAddressV6 (string) –
            • PrivateIpAddressesSet (list) –
              • (dict) –
                • Association (dict) –
                  • IpOwnerId (string) –
                  • PublicDnsName (string) –
                  • PublicIp (string) –
                  • PublicIpV6 (string) –
                • Primary (boolean) –
                • PrivateDnsName (string) –
                • PrivateIpAddress (string) –
            • SourceDestCheck (string) –
            • Status (string) –
            • SubnetId (string) –
            • VpcId (string) –
        • NiftyRedundancy (boolean) –
        • NiftyVpnGatewayDescription (string) –
        • NiftyVpnGatewayName (string) –
        • NiftyVpnGatewayType (string) –
        • RouteTableAssociationId (string) –
        • RouteTableId (string) –
        • State (string) –
        • TagSet (list) –
          • (dict) –
            • Key (string) –
            • Value (string) –
            </