« blib/lib/Paws/Pinpoint/RecommenderConfigurationResponse.pm
↑ Summary
blib/lib/Paws/Pinpoint/RemoveAttributesResponse.pm »
| 1 | |||
| 2 | package Paws::Pinpoint::RemoveAttributes; | ||
| 3 | use Moose; | ||
| 4 | has ApplicationId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'application-id', required => 1); | ||
| 5 | has AttributeType => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'attribute-type', required => 1); | ||
| 6 | has UpdateAttributesRequest => (is => 'ro', isa => 'Paws::Pinpoint::UpdateAttributesRequest', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | class_has _stream_param => (is => 'ro', default => 'UpdateAttributesRequest'); | ||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RemoveAttributes'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/apps/{application-id}/attributes/{attribute-type}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Pinpoint::RemoveAttributesResponse'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Pinpoint::RemoveAttributes - Arguments for method RemoveAttributes on L<Paws::Pinpoint> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method RemoveAttributes on the | ||
| 25 | L<Amazon Pinpoint|Paws::Pinpoint> service. Use the attributes of this class | ||
| 26 | as arguments to method RemoveAttributes. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RemoveAttributes. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $pinpoint = Paws->service('Pinpoint'); | ||
| 33 | my $RemoveAttributesResponse = $pinpoint->RemoveAttributes( | ||
| 34 | ApplicationId => 'My__string', | ||
| 35 | AttributeType => 'My__string', | ||
| 36 | UpdateAttributesRequest => { | ||
| 37 | Blacklist => [ 'My__string', ... ], # OPTIONAL | ||
| 38 | }, | ||
| 39 | |||
| 40 | ); | ||
| 41 | |||
| 42 | # Results: | ||
| 43 | my $AttributesResource = $RemoveAttributesResponse->AttributesResource; | ||
| 44 | |||
| 45 | # Returns a L<Paws::Pinpoint::RemoveAttributesResponse> object. | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pinpoint/RemoveAttributes> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> ApplicationId => Str | ||
| 54 | |||
| 55 | The unique identifier for the application. This identifier is displayed | ||
| 56 | as the B<Project ID> on the Amazon Pinpoint console. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> AttributeType => Str | ||
| 61 | |||
| 62 | The type of attribute or attributes to remove. Valid values are: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | endpoint-custom-attributes - Custom attributes that describe endpoints, | ||
| 69 | such as the date when an associated user opted in or out of receiving | ||
| 70 | communications from you through a specific type of channel. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | endpoint-metric-attributes - Custom metrics that your app reports to | ||
| 75 | Amazon Pinpoint for endpoints, such as the number of app sessions or | ||
| 76 | the number of items left in a cart. | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | endpoint-user-attributes - Custom attributes that describe users, such | ||
| 81 | as first name, last name, and age. | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> UpdateAttributesRequest => L<Paws::Pinpoint::UpdateAttributesRequest> | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method RemoveAttributes in L<Paws::Pinpoint> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |