NAME

Paws::ApiGateway::CreateDocumentationPart - Arguments for method CreateDocumentationPart on Paws::ApiGateway

DESCRIPTION

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

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

SYNOPSIS

    my $apigateway = Paws->service('ApiGateway');
    my $DocumentationPart = $apigateway->CreateDocumentationPart(
      Location => {
        Type => 'API'
        , # values: API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, RESPONSE_BODY
        Method     => 'MyString',                                 # OPTIONAL
        Name       => 'MyString',                                 # OPTIONAL
        Path       => 'MyString',                                 # OPTIONAL
        StatusCode => 'MyDocumentationPartLocationStatusCode',    # OPTIONAL
      },
      Properties => 'MyString',
      RestApiId  => 'MyString',

    );

    # Results:
    my $Id         = $DocumentationPart->Id;
    my $Location   = $DocumentationPart->Location;
    my $Properties = $DocumentationPart->Properties;

    # Returns a L<Paws::ApiGateway::DocumentationPart> 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/apigateway/CreateDocumentationPart

ATTRIBUTES

REQUIRED Location => Paws::ApiGateway::DocumentationPartLocation

[Required] The location of the targeted API entity of the to-be-created documentation part.

REQUIRED Properties => Str

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

REQUIRED RestApiId => Str

[Required] The string identifier of the associated RestApi.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateDocumentationPart in Paws::ApiGateway

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