EC2InstanceConnect

Table of Contents

• EC2InstanceConnect
  • Client
  • Client Exceptions
  • Paginators

Client

class EC2InstanceConnect.Client

A low-level client representing AWS EC2 Instance Connect:

client = session.create_client('ec2-instance-connect')

These are the available methods:

• can_paginate()
• generate_presigned_url()
• get_paginator()
• get_waiter()
• send_ssh_public_key()

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.

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)

Returns an object that can wait for some condition.

Parameters

waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.

Returns

The specified waiter object.

Return type

botocore.waiter.Waiter

send_ssh_public_key(**kwargs)

Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.

See also: AWS API Documentation

Request Syntax

response = client.send_ssh_public_key(
    InstanceId='string',
    InstanceOSUser='string',
    SSHPublicKey='string',
    AvailabilityZone='string'
)

Parameters

• InstanceId (string) --

  [REQUIRED]

  The EC2 instance you wish to publish the SSH key to.

• InstanceOSUser (string) --

  [REQUIRED]

  The OS user on the EC2 instance whom the key may be used to authenticate as.

• SSHPublicKey (string) --

  [REQUIRED]

  The public key to be published to the instance. To use it after publication you must have the matching private key.

• AvailabilityZone (string) --

  [REQUIRED]

  The availability zone the EC2 instance was launched in.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • RequestId (string) --

    The request ID as logged by EC2 Connect. Please provide this when contacting AWS Support.

  • Success (boolean) --

    Indicates request success.

Exceptions

• EC2InstanceConnect.Client.exceptions.AuthException
• EC2InstanceConnect.Client.exceptions.InvalidArgsException
• EC2InstanceConnect.Client.exceptions.ServiceException
• EC2InstanceConnect.Client.exceptions.ThrottlingException
• EC2InstanceConnect.Client.exceptions.EC2InstanceNotFoundException

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

• EC2InstanceConnect.Client.exceptions.AuthException
• EC2InstanceConnect.Client.exceptions.EC2InstanceNotFoundException
• EC2InstanceConnect.Client.exceptions.InvalidArgsException
• EC2InstanceConnect.Client.exceptions.ServiceException
• EC2InstanceConnect.Client.exceptions.ThrottlingException

class EC2InstanceConnect.Client.exceptions.AuthException

Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.

Example

try:
  ...
except client.exceptions.AuthException as e:
  print(e.response)

response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

• (dict) --

  Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.

  • Message (string) --
  • Error (dict) -- Normalized access to common exception attributes.
    • Code (string) -- An identifier specifying the exception type.
    • Message (string) -- A descriptive message explaining why the exception occured.

class EC2InstanceConnect.Client.exceptions.EC2InstanceNotFoundException

Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.

Example

try:
  ...
except client.exceptions.EC2InstanceNotFoundException as e:
  print(e.response)

response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

• (dict) --

  Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.

  • Message (string) --
  • Error (dict) -- Normalized access to common exception attributes.
    • Code (string) -- An identifier specifying the exception type.
    • Message (string) -- A descriptive message explaining why the exception occured.

class EC2InstanceConnect.Client.exceptions.InvalidArgsException

Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.

Example

try:
  ...
except client.exceptions.InvalidArgsException as e:
  print(e.response)

response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

• (dict) --

  Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.

  • Message (string) --
  • Error (dict) -- Normalized access to common exception attributes.
    • Code (string) -- An identifier specifying the exception type.
    • Message (string) -- A descriptive message explaining why the exception occured.

class EC2InstanceConnect.Client.exceptions.ServiceException

Indicates that the service encountered an error. Follow the message's instructions and try again.

Example

try:
  ...
except client.exceptions.ServiceException as e:
  print(e.response)

response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

• (dict) --

  Indicates that the service encountered an error. Follow the message's instructions and try again.

  • Message (string) --
  • Error (dict) -- Normalized access to common exception attributes.
    • Code (string) -- An identifier specifying the exception type.
    • Message (string) -- A descriptive message explaining why the exception occured.

class EC2InstanceConnect.Client.exceptions.ThrottlingException

Indicates you have been making requests too frequently and have been throttled. Wait for a while and try again. If higher call volume is warranted contact AWS Support.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)

response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

• (dict) --

  Indicates you have been making requests too frequently and have been throttled. Wait for a while and try again. If higher call volume is warranted contact AWS Support.

  • Message (string) --
  • Error (dict) -- Normalized access to common exception attributes.
    • Code (string) -- An identifier specifying the exception type.
    • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are: