NAME

Paws::Chime::ListChannels - Arguments for method ListChannels on Paws::Chime

DESCRIPTION

This class represents the parameters used for calling the method ListChannels on the Amazon Chime service. Use the attributes of this class as arguments to method ListChannels.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListChannels.

SYNOPSIS

my $chime = Paws->service('Chime');
my $ListChannelsResponse = $chime->ListChannels(
  AppInstanceArn => 'MyChimeArn',
  ChimeBearer    => 'MyChimeArn',     # OPTIONAL
  MaxResults     => 1,                # OPTIONAL
  NextToken      => 'MyNextToken',    # OPTIONAL
  Privacy        => 'PUBLIC',         # OPTIONAL
);

# Results:
my $Channels  = $ListChannelsResponse->Channels;
my $NextToken = $ListChannelsResponse->NextToken;

# Returns a L<Paws::Chime::ListChannelsResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/chime/ListChannels

ATTRIBUTES

REQUIRED AppInstanceArn => Str

The ARN of the AppInstance.

ChimeBearer => Str

The AppInstanceUserArn of the user that makes the API call.

MaxResults => Int

The maximum number of channels that you want to return.

NextToken => Str

The token passed by previous API calls until all requested channels are returned.

Privacy => Str

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

Valid values are: "PUBLIC", "PRIVATE"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListChannels in Paws::Chime

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues