Class: Twilio::REST::Accounts::V1::CredentialList::AwsList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/accounts/v1/credential/aws.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ AwsList

Initialize the AwsList

Parameters:

  • Version that contains the resource



28
29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 28

def initialize(version)
    super(version)
    
    # Path Solution
    @solution = {  }
    @uri = "/Credentials/AWS"
    
end

Instance Method Details

#create(credentials: nil, friendly_name: :unset, account_sid: :unset) ⇒ AwsInstance

Create the AwsInstance

Parameters:

  • (defaults to: nil)

    A string that contains the AWS access credentials in the format ‘<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example, AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

  • (defaults to: :unset)

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • (defaults to: :unset)

    The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request.

Returns:

  • Created AwsInstance



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 42

def create(
    credentials: nil, 
    friendly_name: :unset, 
    account_sid: :unset
)

    data = Twilio::Values.of({
        'Credentials' => credentials,
        'FriendlyName' => friendly_name,
        'AccountSid' => ,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    AwsInstance.new(
        @version,
        payload,
    )
end

#create_with_metadata(credentials: nil, friendly_name: :unset, account_sid: :unset) ⇒ AwsInstance

Create the AwsInstanceMetadata

Parameters:

  • (defaults to: nil)

    A string that contains the AWS access credentials in the format ‘<AWS_ACCESS_KEY_ID>:<AWS_SECRET_ACCESS_KEY>`. For example, AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

  • (defaults to: :unset)

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • (defaults to: :unset)

    The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request.

Returns:

  • Created AwsInstance



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 73

def create_with_metadata(
  credentials: nil, 
  friendly_name: :unset, 
  account_sid: :unset
)

    data = Twilio::Values.of({
        'Credentials' => credentials,
        'FriendlyName' => friendly_name,
        'AccountSid' => ,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    aws_instance = AwsInstance.new(
        @version,
        response.body,
    )
    AwsInstanceMetadata.new(
        @version,
        aws_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields AwsInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



169
170
171
172
173
174
175
176
177
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 169

def each
    limits = @version.read_limits

    page = self.page(page_size: limits[:page_size], )

    @version.stream(page,
        limit: limits[:limit],
        page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of AwsInstance records from the API. Request is executed immediately.

Parameters:

  • API-generated URL for the requested results page

Returns:

  • Page of AwsInstance



206
207
208
209
210
211
212
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 206

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
AwsPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

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:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    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:

  • Array of up to limit results



116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 116

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(limit: nil, page_size: nil) ⇒ Array

Lists AwsPageMetadata records from the API as a list.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    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:

  • Array of up to limit results



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 152

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    AwsPageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of AwsInstance records from the API. Request is executed immediately.

Parameters:

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of AwsInstance



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 186

def page(page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    AwsPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    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:

  • Enumerable that will yield up to limit results



134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 134

def stream(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        page_size: limits[:page_size], )

    @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



217
218
219
 
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 217

def to_s
    '#<Twilio.Accounts.V1.AwsList>'
end