Python Methods

Table of Contents

• Python Methods
  • Client

send_message(sender, recipient, message_body[, priority=1])

Send a message to a recipient

Parameters:

• sender (str) – The person sending the message
• recipient (str) – The recipient of the message
• message_body (str) – The body of the message
• priority (integer or None) – The priority of the message, can be a number 1-5

Returns:

the message id

Return type:

int

Raises:

• ValueError – if the message_body exceeds 160 characters
• TypeError – if the message_body is not a basestring

Client

class Foo.Client

Lorem ipsum dolor. Lorem ipsum dolor:

client = foo.create_client('baz')

Available methods:

• bar()

bar(**kwargs)

Lorem ipsum dolor. Lorem ipsum dolor.

Request Syntax

response = client.accept_vpc_peering_connection(
    DryRun=True|False,
    VpcPeeringConnectionId='string'
)

Parameters:

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
• VpcPeeringConnectionId (string) – The ID of the VPC peering connection.

Return type:

dict

Returns:

Response Syntax

{
    'VpcPeeringConnection': {
        'AccepterVpcInfo': {
            'CidrBlock': 'string',
            'OwnerId': 'string',
            'VpcId': 'string'
        },
        'ExpirationTime': datetime(2015, 1, 1),
        'RequesterVpcInfo': {
            'CidrBlock': 'string',
            'OwnerId': 'string',
            'VpcId': 'string'
        },
        'Status': {
            'Code': 'string',
            'Message': 'string'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'VpcPeeringConnectionId': 'string'
    }
}

Response Structure

• (dict) –

  • VpcPeeringConnection (dict) – Information about the VPC peering connection.

    • AccepterVpcInfo (dict) – The information of the peer VPC.

      • CidrBlock (string) – The CIDR block for the VPC.

        • OwnerId (string) – The AWS account ID of the VPC owner.

        • VpcId (string) – The ID of the VPC.

        • ExpirationTime (datetime) – The time that an unaccepted VPC peering connection will expire.

        • RequesterVpcInfo (dict) – The information of the requester VPC.

          • CidrBlock (string) – The CIDR block for the VPC.

          • OwnerId (string) – The AWS account ID of the VPC owner.

          • VpcId (string) – The ID of the VPC.

          • Status (dict) – The status of the VPC peering connection.

          • Code (string) – The status of the VPC peering connection.

          • Message (string) – A message that provides more information about the status, if applicable.

          • Tags (list) – Any tags assigned to the resource.

            • (dict) – Describes a tag.

              • Key (string) – The key of the tag.

                Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

              • Value (string) – The value of the tag.

                Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

              • VpcPeeringConnectionId (string) – The ID of the VPC peering connection.