File Coverage

blib/lib/Paws/Snowball/Address.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Snowball::Address;
2 1     1   463 use Moose;
  1         4  
  1         10  
3             has AddressId => (is => 'ro', isa => 'Str');
4             has City => (is => 'ro', isa => 'Str');
5             has Company => (is => 'ro', isa => 'Str');
6             has Country => (is => 'ro', isa => 'Str');
7             has IsRestricted => (is => 'ro', isa => 'Bool');
8             has Landmark => (is => 'ro', isa => 'Str');
9             has Name => (is => 'ro', isa => 'Str');
10             has PhoneNumber => (is => 'ro', isa => 'Str');
11             has PostalCode => (is => 'ro', isa => 'Str');
12             has PrefectureOrDistrict => (is => 'ro', isa => 'Str');
13             has StateOrProvince => (is => 'ro', isa => 'Str');
14             has Street1 => (is => 'ro', isa => 'Str');
15             has Street2 => (is => 'ro', isa => 'Str');
16             has Street3 => (is => 'ro', isa => 'Str');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::Snowball::Address
24              
25             =head1 USAGE
26              
27             This class represents one of two things:
28              
29             =head3 Arguments in a call to a service
30              
31             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
32             Each attribute should be used as a named argument in the calls that expect this type of object.
33              
34             As an example, if Att1 is expected to be a Paws::Snowball::Address object:
35              
36             $service_obj->Method(Att1 => { AddressId => $value, ..., Street3 => $value });
37              
38             =head3 Results returned from an API call
39              
40             Use accessors for each attribute. If Att1 is expected to be an Paws::Snowball::Address object:
41              
42             $result = $service_obj->Method(...);
43             $result->Att1->AddressId
44              
45             =head1 DESCRIPTION
46              
47             The address that you want the Snowball or Snowballs associated with a
48             specific job to be shipped to. Addresses are validated at the time of
49             creation. The address you provide must be located within the
50             serviceable area of your region. Although no individual elements of the
51             C<Address> are required, if the address is invalid or unsupported, then
52             an exception is thrown.
53              
54             =head1 ATTRIBUTES
55              
56              
57             =head2 AddressId => Str
58              
59             The unique ID for an address.
60              
61              
62             =head2 City => Str
63              
64             The city in an address that a Snowball is to be delivered to.
65              
66              
67             =head2 Company => Str
68              
69             The name of the company to receive a Snowball at an address.
70              
71              
72             =head2 Country => Str
73              
74             The country in an address that a Snowball is to be delivered to.
75              
76              
77             =head2 IsRestricted => Bool
78              
79             If the address you are creating is a primary address, then set this
80             option to true. This field is not supported in most regions.
81              
82              
83             =head2 Landmark => Str
84              
85             This field is no longer used and the value is ignored.
86              
87              
88             =head2 Name => Str
89              
90             The name of a person to receive a Snowball at an address.
91              
92              
93             =head2 PhoneNumber => Str
94              
95             The phone number associated with an address that a Snowball is to be
96             delivered to.
97              
98              
99             =head2 PostalCode => Str
100              
101             The postal code in an address that a Snowball is to be delivered to.
102              
103              
104             =head2 PrefectureOrDistrict => Str
105              
106             This field is no longer used and the value is ignored.
107              
108              
109             =head2 StateOrProvince => Str
110              
111             The state or province in an address that a Snowball is to be delivered
112             to.
113              
114              
115             =head2 Street1 => Str
116              
117             The first line in a street address that a Snowball is to be delivered
118             to.
119              
120              
121             =head2 Street2 => Str
122              
123             The second line in a street address that a Snowball is to be delivered
124             to.
125              
126              
127             =head2 Street3 => Str
128              
129             The third line in a street address that a Snowball is to be delivered
130             to.
131              
132              
133              
134             =head1 SEE ALSO
135              
136             This class forms part of L<Paws>, describing an object used in L<Paws::Snowball>
137              
138             =head1 BUGS and CONTRIBUTIONS
139              
140             The source code is located here: https://github.com/pplu/aws-sdk-perl
141              
142             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
143              
144             =cut
145