twilio.rest.accounts.v1.credential package¶
Submodules¶
twilio.rest.accounts.v1.credential.aws module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.accounts.v1.credential.aws.
AwsContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the AwsInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the AwsInstance
Returns: The fetched AwsInstance Return type: twilio.rest.accounts.v1.credential.aws.AwsInstance
-
update
(friendly_name=<object object>)[source]¶ Update the AwsInstance
Parameters: friendly_name (unicode) – A string to describe the resource Returns: The updated AwsInstance Return type: twilio.rest.accounts.v1.credential.aws.AwsInstance
-
-
class
twilio.rest.accounts.v1.credential.aws.
AwsInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
date_created
¶ Returns: The RFC 2822 date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The RFC 2822 date and time in GMT when the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the AwsInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the AwsInstance
Returns: The fetched AwsInstance Return type: twilio.rest.accounts.v1.credential.aws.AwsInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
update
(friendly_name=<object object>)[source]¶ Update the AwsInstance
Parameters: friendly_name (unicode) – A string to describe the resource Returns: The updated AwsInstance Return type: twilio.rest.accounts.v1.credential.aws.AwsInstance
-
url
¶ Returns: The URI for this resource, relative to https://accounts.twilio.com Return type: unicode
-
-
class
twilio.rest.accounts.v1.credential.aws.
AwsList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(credentials, friendly_name=<object object>, account_sid=<object object>)[source]¶ Create the AwsInstance
Parameters: - credentials (unicode) – A string that contains the AWS access credentials in the format <AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>
- friendly_name (unicode) – A string to describe the resource
- account_sid (unicode) – The Subaccount this Credential should be associated with.
Returns: The created AwsInstance
Return type:
-
get
(sid)[source]¶ Constructs a AwsContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.accounts.v1.credential.aws.AwsContext Return type: twilio.rest.accounts.v1.credential.aws.AwsContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of AwsInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of AwsInstance Return type: twilio.rest.accounts.v1.credential.aws.AwsPage
-
list
(limit=None, page_size=None)[source]¶ Lists AwsInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type:
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of AwsInstance records from the API. Request is executed immediately
Parameters: Returns: Page of AwsInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams AwsInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type:
-
-
class
twilio.rest.accounts.v1.credential.aws.
AwsPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of AwsInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.accounts.v1.credential.aws.AwsInstance Return type: twilio.rest.accounts.v1.credential.aws.AwsInstance
-
twilio.rest.accounts.v1.credential.public_key module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.accounts.v1.credential.public_key.
PublicKeyContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the PublicKeyInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the PublicKeyInstance
Returns: The fetched PublicKeyInstance Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance
-
update
(friendly_name=<object object>)[source]¶ Update the PublicKeyInstance
Parameters: friendly_name (unicode) – A string to describe the resource Returns: The updated PublicKeyInstance Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance
-
-
class
twilio.rest.accounts.v1.credential.public_key.
PublicKeyInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the Credential that the PublicKey resource belongs to Return type: unicode
-
date_created
¶ Returns: The RFC 2822 date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The RFC 2822 date and time in GMT when the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the PublicKeyInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the PublicKeyInstance
Returns: The fetched PublicKeyInstance Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
update
(friendly_name=<object object>)[source]¶ Update the PublicKeyInstance
Parameters: friendly_name (unicode) – A string to describe the resource Returns: The updated PublicKeyInstance Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance
-
url
¶ Returns: The URI for this resource, relative to https://accounts.twilio.com Return type: unicode
-
-
class
twilio.rest.accounts.v1.credential.public_key.
PublicKeyList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(public_key, friendly_name=<object object>, account_sid=<object object>)[source]¶ Create the PublicKeyInstance
Parameters: - public_key (unicode) – A URL encoded representation of the public key
- friendly_name (unicode) – A string to describe the resource
- account_sid (unicode) – The Subaccount this Credential should be associated with.
Returns: The created PublicKeyInstance
Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance
-
get
(sid)[source]¶ Constructs a PublicKeyContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.accounts.v1.credential.public_key.PublicKeyContext Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of PublicKeyInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of PublicKeyInstance Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyPage
-
list
(limit=None, page_size=None)[source]¶ Lists PublicKeyInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of PublicKeyInstance records from the API. Request is executed immediately
Parameters: Returns: Page of PublicKeyInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams PublicKeyInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance]
-
-
class
twilio.rest.accounts.v1.credential.public_key.
PublicKeyPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of PublicKeyInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.accounts.v1.credential.
CredentialList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
aws
¶ Access the aws
Returns: twilio.rest.accounts.v1.credential.aws.AwsList Return type: twilio.rest.accounts.v1.credential.aws.AwsList
-
public_key
¶ Access the public_key
Returns: twilio.rest.accounts.v1.credential.public_key.PublicKeyList Return type: twilio.rest.accounts.v1.credential.public_key.PublicKeyList
-
-
class
twilio.rest.accounts.v1.credential.
CredentialPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CredentialInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.accounts.v1.credential.CredentialInstance Return type: twilio.rest.accounts.v1.credential.CredentialInstance
-