| 1 | |||
| 2 | package Paws::Chime::CreateChannel; | ||
| 3 | use Moose; | ||
| 4 | has AppInstanceArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ChimeBearer => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-chime-bearer'); | ||
| 6 | has ClientRequestToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Metadata => (is => 'ro', isa => 'Str'); | ||
| 8 | has Mode => (is => 'ro', isa => 'Str'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has Privacy => (is => 'ro', isa => 'Str'); | ||
| 11 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Chime::Tag]'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateChannel'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/channels'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Chime::CreateChannelResponse'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Chime::CreateChannel - Arguments for method CreateChannel on L<Paws::Chime> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method CreateChannel on the | ||
| 30 | L<Amazon Chime|Paws::Chime> service. Use the attributes of this class | ||
| 31 | as arguments to method CreateChannel. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateChannel. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $chime = Paws->service('Chime'); | ||
| 38 | my $CreateChannelResponse = $chime->CreateChannel( | ||
| 39 | AppInstanceArn => 'MyChimeArn', | ||
| 40 | ClientRequestToken => 'MyClientRequestToken', | ||
| 41 | Name => 'MyNonEmptyResourceName', | ||
| 42 | ChimeBearer => 'MyChimeArn', # OPTIONAL | ||
| 43 | Metadata => 'MyMetadata', # OPTIONAL | ||
| 44 | Mode => 'UNRESTRICTED', # OPTIONAL | ||
| 45 | Privacy => 'PUBLIC', # OPTIONAL | ||
| 46 | Tags => [ | ||
| 47 | { | ||
| 48 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 49 | Value => 'MyTagValue', # min: 1, max: 256 | ||
| 50 | |||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $ChannelArn = $CreateChannelResponse->ChannelArn; | ||
| 58 | |||
| 59 | # Returns a L<Paws::Chime::CreateChannelResponse> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/chime/CreateChannel> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> AppInstanceArn => Str | ||
| 68 | |||
| 69 | The ARN of the channel request. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ChimeBearer => Str | ||
| 74 | |||
| 75 | The C<AppInstanceUserArn> of the user that makes the API call. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> ClientRequestToken => Str | ||
| 80 | |||
| 81 | The client token for the request. An C<Idempotency> token. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 Metadata => Str | ||
| 86 | |||
| 87 | The metadata of the creation request. Limited to 1KB and UTF-8. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 Mode => Str | ||
| 92 | |||
| 93 | The channel mode: C<UNRESTRICTED> or C<RESTRICTED>. Administrators, | ||
| 94 | moderators, and channel members can add themselves and other members to | ||
| 95 | unrestricted channels. Only administrators and moderators can add | ||
| 96 | members to restricted channels. | ||
| 97 | |||
| 98 | Valid values are: C<"UNRESTRICTED">, C<"RESTRICTED"> | ||
| 99 | |||
| 100 | =head2 B<REQUIRED> Name => Str | ||
| 101 | |||
| 102 | The name of the channel. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 Privacy => Str | ||
| 107 | |||
| 108 | The channel's privacy level: C<PUBLIC> or C<PRIVATE>. Private channels | ||
| 109 | aren't discoverable by users outside the channel. Public channels are | ||
| 110 | discoverable by anyone in the C<AppInstance>. | ||
| 111 | |||
| 112 | Valid values are: C<"PUBLIC">, C<"PRIVATE"> | ||
| 113 | |||
| 114 | =head2 Tags => ArrayRef[L<Paws::Chime::Tag>] | ||
| 115 | |||
| 116 | The tags for the creation request. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method CreateChannel in L<Paws::Chime> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |