« blib/lib/Paws/Pinpoint/UpdateEmailTemplateResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/UpdateEndpointResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::UpdateEndpoint; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has EndpointId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'endpoint-id', required => 1); | ||
| 6 | has EndpointRequest => (is => 'ro', isa => 'Paws::Pinpoint::EndpointRequest', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | class_has _stream_param => (is => 'ro', default => 'EndpointRequest'); | ||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEndpoint'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/endpoints/{endpoint-id}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::UpdateEndpointResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Pinpoint::UpdateEndpoint - Arguments for method UpdateEndpoint on L<Paws::Pinpoint> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateEndpoint on the | ||
| 25 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateEndpoint. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEndpoint. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 33 | my $UpdateEndpointResponse = $pinpoint->UpdateEndpoint( | ||
| 34 | ApplicationId => 'My__string', | ||
| 35 | EndpointId => 'My__string', | ||
| 36 | EndpointRequest => { | ||
| 37 | Address => 'My__string', | ||
| 38 | Attributes => { 'My__string' => [ 'My__string', ... ], }, # OPTIONAL | ||
| 39 | ChannelType => 'PUSH' | ||
| 40 | , # values: PUSH, GCM, APNS, APNS_SANDBOX, APNS_VOIP, APNS_VOIP_SANDBOX, ADM, SMS, VOICE, EMAIL, BAIDU, CUSTOM; OPTIONAL | ||
| 41 | Demographic => { | ||
| 42 | AppVersion => 'My__string', | ||
| 43 | Locale => 'My__string', | ||
| 44 | Make => 'My__string', | ||
| 45 | Model => 'My__string', | ||
| 46 | ModelVersion => 'My__string', | ||
| 47 | Platform => 'My__string', | ||
| 48 | PlatformVersion => 'My__string', | ||
| 49 | Timezone => 'My__string', | ||
| 50 | }, # OPTIONAL | ||
| 51 | EffectiveDate => 'My__string', | ||
| 52 | EndpointStatus => 'My__string', | ||
| 53 | Location => { | ||
| 54 | City => 'My__string', | ||
| 55 | Country => 'My__string', | ||
| 56 | Latitude => 1, # OPTIONAL | ||
| 57 | Longitude => 1, # OPTIONAL | ||
| 58 | PostalCode => 'My__string', | ||
| 59 | Region => 'My__string', | ||
| 60 | }, # OPTIONAL | ||
| 61 | Metrics => { | ||
| 62 | 'My__string' => 1, # , value: OPTIONAL | ||
| 63 | }, # OPTIONAL | ||
| 64 | OptOut => 'My__string', | ||
| 65 | RequestId => 'My__string', | ||
| 66 | User => { | ||
| 67 | UserAttributes => { 'My__string' => [ 'My__string', ... ], } | ||
| 68 | , # OPTIONAL | ||
| 69 | UserId => 'My__string', | ||
| 70 | }, # OPTIONAL | ||
| 71 | }, | ||
| 72 | |||
| 73 | ); | ||
| 74 | |||
| 75 | # Results: | ||
| 76 | my $MessageBody = $UpdateEndpointResponse->MessageBody; | ||
| 77 | |||
| 78 | # Returns a L<Paws::Pinpoint::UpdateEndpointResponse> object. | ||
| 79 | |||
| 80 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 81 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/UpdateEndpoint> | ||
| 82 | |||
| 83 | =head1 ATTRIBUTES | ||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 87 | |||
| 88 | The unique identifier for the application. This identifier is displayed | ||
| 89 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> EndpointId => Str | ||
| 94 | |||
| 95 | The unique identifier for the endpoint. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> EndpointRequest => L<Paws::Pinpoint::EndpointRequest> | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, documenting arguments for method UpdateEndpoint in L<Paws::Pinpoint> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |