« blib/lib/Paws/Connect/CreateContactFlowResponse.pm
↑ Summary
blib/lib/Paws/Connect/CreateInstanceResponse.pm »
| 1 | |||
| 2 | package Paws::Connect::CreateInstance; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has DirectoryId => (is => 'ro', isa => 'Str'); | ||
| 6 | has IdentityManagementType => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has InboundCallsEnabled => (is => 'ro', isa => 'Bool', required => 1); | ||
| 8 | has InstanceAlias => (is => 'ro', isa => 'Str'); | ||
| 9 | has OutboundCallsEnabled => (is => 'ro', isa => 'Bool', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateInstance'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/instance'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Connect::CreateInstanceResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Connect::CreateInstance - Arguments for method CreateInstance on L<Paws::Connect> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateInstance on the | ||
| 28 | L<Amazon Connect Service|Paws::Connect> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateInstance. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateInstance. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $connect = Paws->service('Connect'); | ||
| 36 | my $CreateInstanceResponse = $connect->CreateInstance( | ||
| 37 | IdentityManagementType => 'SAML', | ||
| 38 | InboundCallsEnabled => 1, | ||
| 39 | OutboundCallsEnabled => 1, | ||
| 40 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 41 | DirectoryId => 'MyDirectoryId', # OPTIONAL | ||
| 42 | InstanceAlias => 'MyDirectoryAlias', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Arn = $CreateInstanceResponse->Arn; | ||
| 47 | my $Id = $CreateInstanceResponse->Id; | ||
| 48 | |||
| 49 | # Returns a L<Paws::Connect::CreateInstanceResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/connect/CreateInstance> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ClientToken => Str | ||
| 58 | |||
| 59 | The idempotency token. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 DirectoryId => Str | ||
| 64 | |||
| 65 | The identifier for the directory. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> IdentityManagementType => Str | ||
| 70 | |||
| 71 | The type of identity management for your Amazon Connect users. | ||
| 72 | |||
| 73 | Valid values are: C<"SAML">, C<"CONNECT_MANAGED">, C<"EXISTING_DIRECTORY"> | ||
| 74 | |||
| 75 | =head2 B<REQUIRED> InboundCallsEnabled => Bool | ||
| 76 | |||
| 77 | Your contact center handles incoming contacts. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 InstanceAlias => Str | ||
| 82 | |||
| 83 | The name for your instance. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> OutboundCallsEnabled => Bool | ||
| 88 | |||
| 89 | Your contact center allows outbound calls. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method CreateInstance in L<Paws::Connect> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |