class Amazonite::ApiGateway::Client

Defined in:

api_gateway/client.cr

Constant Summary

EXCEPTION_FACTORY = ExceptionFactory.new
Log = ::Log.for("amazonite.api_gateway.client")

Constructors

Instance Method Summary

Instance methods inherited from class Amazonite::Core::Client

post(command, url, body : String) post, query_request(command : String, body : String) query_request, rest_request(command : String, method : String, path : String, headers : HTTP::Headers, body : String | Nil) rest_request

Constructor methods inherited from class Amazonite::Core::Client

new(target_prefix : String, endpoint_prefix : String, json_version : String, exception_factory : ResponseExceptionFactory, config : Amazonite::Core::Config = Config.new) new

Constructor Detail

def self.new(config = Core::Config.new) #

[View source]

Instance Method Detail

def create_api_key(input : AAG::CreateApiKeyRequest) : Core::ParsedResponse(AAG::ApiKey) #

Create an ApiKey resource.


[View source]
def create_authorizer(input : AAG::CreateAuthorizerRequest) : Core::ParsedResponse(AAG::Authorizer) #

Adds a new Authorizer resource to an existing RestApi resource.


[View source]
def create_base_path_mapping(input : AAG::CreateBasePathMappingRequest) : Core::ParsedResponse(AAG::BasePathMapping) #

Creates a new BasePathMapping resource.


[View source]
def create_deployment(input : AAG::CreateDeploymentRequest) : Core::ParsedResponse(AAG::Deployment) #

Creates a Deployment resource, which makes a specified RestApi callable over the internet.


[View source]
def create_documentation_part(input : AAG::CreateDocumentationPartRequest) : Core::ParsedResponse(AAG::DocumentationPart) #

Creates a documentation part.


[View source]
def create_documentation_version(input : AAG::CreateDocumentationVersionRequest) : Core::ParsedResponse(AAG::DocumentationVersion) #

Creates a documentation version


[View source]
def create_domain_name(input : AAG::CreateDomainNameRequest) : Core::ParsedResponse(AAG::DomainName) #

Creates a new domain name.


[View source]
def create_domain_name_access_association(input : AAG::CreateDomainNameAccessAssociationRequest) : Core::ParsedResponse(AAG::DomainNameAccessAssociation) #

Creates a domain name access association resource between an access association source and a private custom domain name.


[View source]
def create_model(input : AAG::CreateModelRequest) : Core::ParsedResponse(AAG::Model) #

Adds a new Model resource to an existing RestApi resource.


[View source]
def create_request_validator(input : AAG::CreateRequestValidatorRequest) : Core::ParsedResponse(AAG::RequestValidator) #

Creates a RequestValidator of a given RestApi.


[View source]
def create_resource(input : AAG::CreateResourceRequest) : Core::ParsedResponse(AAG::Resource) #

Creates a Resource resource.


[View source]
def create_rest_api(input : AAG::CreateRestApiRequest) : Core::ParsedResponse(AAG::RestApi) #

Creates a new RestApi resource.


[View source]
def create_stage(input : AAG::CreateStageRequest) : Core::ParsedResponse(AAG::Stage) #

Creates a new Stage resource that references a pre-existing Deployment for the API.


[View source]
def create_usage_plan(input : AAG::CreateUsagePlanRequest) : Core::ParsedResponse(AAG::UsagePlan) #

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.


[View source]
def create_usage_plan_key(input : AAG::CreateUsagePlanKeyRequest) : Core::ParsedResponse(AAG::UsagePlanKey) #

Creates a usage plan key for adding an existing API key to a usage plan.


[View source]
def create_vpc_link(input : AAG::CreateVpcLinkRequest) : Core::ParsedResponse(AAG::VpcLink) #

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.


[View source]
def delete_api_key(input : AAG::DeleteApiKeyRequest) : Core::Response #

Deletes the ApiKey resource.


[View source]
def delete_authorizer(input : AAG::DeleteAuthorizerRequest) : Core::Response #

Deletes an existing Authorizer resource.


[View source]
def delete_base_path_mapping(input : AAG::DeleteBasePathMappingRequest) : Core::Response #

Deletes the BasePathMapping resource.


[View source]
def delete_client_certificate(input : AAG::DeleteClientCertificateRequest) : Core::Response #

Deletes the ClientCertificate resource.


[View source]
def delete_deployment(input : AAG::DeleteDeploymentRequest) : Core::Response #

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.


[View source]
def delete_documentation_part(input : AAG::DeleteDocumentationPartRequest) : Core::Response #

Deletes a documentation part


[View source]
def delete_documentation_version(input : AAG::DeleteDocumentationVersionRequest) : Core::Response #

Deletes a documentation version.


[View source]
def delete_domain_name(input : AAG::DeleteDomainNameRequest) : Core::Response #

Deletes the DomainName resource.


[View source]
def delete_domain_name_access_association(input : AAG::DeleteDomainNameAccessAssociationRequest) : Core::Response #

Deletes the DomainNameAccessAssociation resource.

Only the AWS account that created the DomainNameAccessAssociation resource can delete it. To stop an access association source in another AWS account from accessing your private custom domain name, use the RejectDomainNameAccessAssociation operation.


[View source]
def delete_gateway_response(input : AAG::DeleteGatewayResponseRequest) : Core::Response #

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.


[View source]
def delete_integration(input : AAG::DeleteIntegrationRequest) : Core::Response #

Represents a delete integration.


[View source]
def delete_integration_response(input : AAG::DeleteIntegrationResponseRequest) : Core::Response #

Represents a delete integration response.


[View source]
def delete_method(input : AAG::DeleteMethodRequest) : Core::Response #

Deletes an existing Method resource.


[View source]
def delete_method_response(input : AAG::DeleteMethodResponseRequest) : Core::Response #

Deletes an existing MethodResponse resource.


[View source]
def delete_model(input : AAG::DeleteModelRequest) : Core::Response #

Deletes a model.


[View source]
def delete_request_validator(input : AAG::DeleteRequestValidatorRequest) : Core::Response #

Deletes a RequestValidator of a given RestApi.


[View source]
def delete_resource(input : AAG::DeleteResourceRequest) : Core::Response #

Deletes a Resource resource.


[View source]
def delete_rest_api(input : AAG::DeleteRestApiRequest) : Core::Response #

Deletes the specified API.


[View source]
def delete_stage(input : AAG::DeleteStageRequest) : Core::Response #

Deletes a Stage resource.


[View source]
def delete_usage_plan(input : AAG::DeleteUsagePlanRequest) : Core::Response #

Deletes a usage plan of a given plan Id.


[View source]
def delete_usage_plan_key(input : AAG::DeleteUsagePlanKeyRequest) : Core::Response #

Deletes a usage plan key and remove the underlying API key from the associated usage plan.


[View source]
def delete_vpc_link(input : AAG::DeleteVpcLinkRequest) : Core::Response #

Deletes an existing VpcLink of a specified identifier.


[View source]
def flush_stage_authorizers_cache(input : AAG::FlushStageAuthorizersCacheRequest) : Core::Response #

Flushes all authorizer cache entries on a stage.


[View source]
def flush_stage_cache(input : AAG::FlushStageCacheRequest) : Core::Response #

Flushes a stage's cache.


[View source]
def generate_client_certificate(input : AAG::GenerateClientCertificateRequest) : Core::ParsedResponse(AAG::ClientCertificate) #

Generates a ClientCertificate resource.


[View source]
def get_account(input : AAG::GetAccountRequest) : Core::ParsedResponse(AAG::Account) #

Gets information about the current Account resource.


[View source]
def get_api_key(input : AAG::GetApiKeyRequest) : Core::ParsedResponse(AAG::ApiKey) #

Gets information about the current ApiKey resource.


[View source]
def get_api_keys(input : AAG::GetApiKeysRequest) : Core::ParsedResponse(AAG::ApiKeys) #

Gets information about the current ApiKeys resource.


[View source]
def get_authorizer(input : AAG::GetAuthorizerRequest) : Core::ParsedResponse(AAG::Authorizer) #

Describe an existing Authorizer resource.


[View source]
def get_authorizers(input : AAG::GetAuthorizersRequest) : Core::ParsedResponse(AAG::Authorizers) #

Describe an existing Authorizers resource.


[View source]
def get_base_path_mapping(input : AAG::GetBasePathMappingRequest) : Core::ParsedResponse(AAG::BasePathMapping) #

Describe a BasePathMapping resource.


[View source]
def get_base_path_mappings(input : AAG::GetBasePathMappingsRequest) : Core::ParsedResponse(AAG::BasePathMappings) #

Represents a collection of BasePathMapping resources.


[View source]
def get_client_certificate(input : AAG::GetClientCertificateRequest) : Core::ParsedResponse(AAG::ClientCertificate) #

Gets information about the current ClientCertificate resource.


[View source]
def get_client_certificates(input : AAG::GetClientCertificatesRequest) : Core::ParsedResponse(AAG::ClientCertificates) #

Gets a collection of ClientCertificate resources.


[View source]
def get_deployment(input : AAG::GetDeploymentRequest) : Core::ParsedResponse(AAG::Deployment) #

Gets information about a Deployment resource.


[View source]
def get_deployments(input : AAG::GetDeploymentsRequest) : Core::ParsedResponse(AAG::Deployments) #

Gets information about a Deployments collection.


[View source]
def get_documentation_part(input : AAG::GetDocumentationPartRequest) : Core::ParsedResponse(AAG::DocumentationPart) #

Gets a documentation part.


[View source]
def get_documentation_parts(input : AAG::GetDocumentationPartsRequest) : Core::ParsedResponse(AAG::DocumentationParts) #

Gets documentation parts.


[View source]
def get_documentation_version(input : AAG::GetDocumentationVersionRequest) : Core::ParsedResponse(AAG::DocumentationVersion) #

Gets a documentation version.


[View source]
def get_documentation_versions(input : AAG::GetDocumentationVersionsRequest) : Core::ParsedResponse(AAG::DocumentationVersions) #

Gets documentation versions.


[View source]
def get_domain_name(input : AAG::GetDomainNameRequest) : Core::ParsedResponse(AAG::DomainName) #

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.


[View source]
def get_domain_name_access_associations(input : AAG::GetDomainNameAccessAssociationsRequest) : Core::ParsedResponse(AAG::DomainNameAccessAssociations) #

Represents a collection on DomainNameAccessAssociations resources.


[View source]
def get_domain_names(input : AAG::GetDomainNamesRequest) : Core::ParsedResponse(AAG::DomainNames) #

Represents a collection of DomainName resources.


[View source]
def get_export(input : AAG::GetExportRequest) : Core::ParsedResponse(AAG::ExportResponse) #

Exports a deployed version of a RestApi in a specified format.


[View source]
def get_gateway_response(input : AAG::GetGatewayResponseRequest) : Core::ParsedResponse(AAG::GatewayResponse) #

Gets a GatewayResponse of a specified response type on the given RestApi.


[View source]
def get_gateway_responses(input : AAG::GetGatewayResponsesRequest) : Core::ParsedResponse(AAG::GatewayResponses) #

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.


[View source]
def get_integration(input : AAG::GetIntegrationRequest) : Core::ParsedResponse(AAG::Integration) #

Get the integration settings.


[View source]
def get_integration_response(input : AAG::GetIntegrationResponseRequest) : Core::ParsedResponse(AAG::IntegrationResponse) #

Represents a get integration response.


[View source]
def get_method(input : AAG::GetMethodRequest) : Core::ParsedResponse(AAG::Method) #

Describe an existing Method resource.


[View source]
def get_method_response(input : AAG::GetMethodResponseRequest) : Core::ParsedResponse(AAG::MethodResponse) #

Describes a MethodResponse resource.


[View source]
def get_model(input : AAG::GetModelRequest) : Core::ParsedResponse(AAG::Model) #

Describes an existing model defined for a RestApi resource.


[View source]
def get_model_template(input : AAG::GetModelTemplateRequest) : Core::ParsedResponse(AAG::Template) #

Generates a sample mapping template that can be used to transform a payload into the structure of a model.


[View source]
def get_models(input : AAG::GetModelsRequest) : Core::ParsedResponse(AAG::Models) #

Describes existing Models defined for a RestApi resource.


[View source]
def get_request_validator(input : AAG::GetRequestValidatorRequest) : Core::ParsedResponse(AAG::RequestValidator) #

Gets a RequestValidator of a given RestApi.


[View source]
def get_request_validators(input : AAG::GetRequestValidatorsRequest) : Core::ParsedResponse(AAG::RequestValidators) #

Gets the RequestValidators collection of a given RestApi.


[View source]
def get_resource(input : AAG::GetResourceRequest) : Core::ParsedResponse(AAG::Resource) #

Lists information about a resource.


[View source]
def get_resources(input : AAG::GetResourcesRequest) : Core::ParsedResponse(AAG::Resources) #

Lists information about a collection of Resource resources.


[View source]
def get_rest_api(input : AAG::GetRestApiRequest) : Core::ParsedResponse(AAG::RestApi) #

Lists the RestApi resource in the collection.


[View source]
def get_rest_apis(input : AAG::GetRestApisRequest) : Core::ParsedResponse(AAG::RestApis) #

Lists the RestApis resources for your collection.


[View source]
def get_sdk(input : AAG::GetSdkRequest) : Core::ParsedResponse(AAG::SdkResponse) #

Generates a client SDK for a RestApi and Stage.


[View source]
def get_sdk_type(input : AAG::GetSdkTypeRequest) : Core::ParsedResponse(AAG::SdkType) #

Gets an SDK type.


[View source]
def get_sdk_types(input : AAG::GetSdkTypesRequest) : Core::ParsedResponse(AAG::SdkTypes) #

Gets SDK types


[View source]
def get_stage(input : AAG::GetStageRequest) : Core::ParsedResponse(AAG::Stage) #

Gets information about a Stage resource.


[View source]
def get_stages(input : AAG::GetStagesRequest) : Core::ParsedResponse(AAG::Stages) #

Gets information about one or more Stage resources.


[View source]
def get_tags(input : AAG::GetTagsRequest) : Core::ParsedResponse(AAG::Tags) #

Gets the Tags collection for a given resource.


[View source]
def get_usage(input : AAG::GetUsageRequest) : Core::ParsedResponse(AAG::Usage) #

Gets the usage data of a usage plan in a specified time interval.


[View source]
def get_usage_plan(input : AAG::GetUsagePlanRequest) : Core::ParsedResponse(AAG::UsagePlan) #

Gets a usage plan of a given plan identifier.


[View source]
def get_usage_plan_key(input : AAG::GetUsagePlanKeyRequest) : Core::ParsedResponse(AAG::UsagePlanKey) #

Gets a usage plan key of a given key identifier.


[View source]
def get_usage_plan_keys(input : AAG::GetUsagePlanKeysRequest) : Core::ParsedResponse(AAG::UsagePlanKeys) #

Gets all the usage plan keys representing the API keys added to a specified usage plan.


[View source]
def get_usage_plans(input : AAG::GetUsagePlansRequest) : Core::ParsedResponse(AAG::UsagePlans) #

Gets all the usage plans of the caller's account.


[View source]
def get_vpc_link(input : AAG::GetVpcLinkRequest) : Core::ParsedResponse(AAG::VpcLink) #

Gets a specified VPC link under the caller's account in a region.


[View source]
def get_vpc_links(input : AAG::GetVpcLinksRequest) : Core::ParsedResponse(AAG::VpcLinks) #

Gets the VpcLinks collection under the caller's account in a selected region.


[View source]
def import_api_keys(input : AAG::ImportApiKeysRequest) : Core::ParsedResponse(AAG::ApiKeyIds) #

Import API keys from an external source, such as a CSV-formatted file.


[View source]
def import_documentation_parts(input : AAG::ImportDocumentationPartsRequest) : Core::ParsedResponse(AAG::DocumentationPartIds) #

Imports documentation parts


[View source]
def import_rest_api(input : AAG::ImportRestApiRequest) : Core::ParsedResponse(AAG::RestApi) #

A feature of the API Gateway control service for creating a new API from an external API definition file.


[View source]
def put_gateway_response(input : AAG::PutGatewayResponseRequest) : Core::ParsedResponse(AAG::GatewayResponse) #

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.


[View source]
def put_integration(input : AAG::PutIntegrationRequest) : Core::ParsedResponse(AAG::Integration) #

Sets up a method's integration.


[View source]
def put_integration_response(input : AAG::PutIntegrationResponseRequest) : Core::ParsedResponse(AAG::IntegrationResponse) #

Represents a put integration.


[View source]
def put_method(input : AAG::PutMethodRequest) : Core::ParsedResponse(AAG::Method) #

Add a method to an existing Resource resource.


[View source]
def put_method_response(input : AAG::PutMethodResponseRequest) : Core::ParsedResponse(AAG::MethodResponse) #

Adds a MethodResponse to an existing Method resource.


[View source]
def put_rest_api(input : AAG::PutRestApiRequest) : Core::ParsedResponse(AAG::RestApi) #

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.


[View source]
def reject_domain_name_access_association(input : AAG::RejectDomainNameAccessAssociationRequest) : Core::Response #

Rejects a domain name access association with a private custom domain name.

To reject a domain name access association with an access association source in another AWS account, use this operation. To remove a domain name access association with an access association source in your own account, use the DeleteDomainNameAccessAssociation operation.


[View source]
def tag_resource(input : AAG::TagResourceRequest) : Core::Response #

Adds or updates a tag on a given resource.


[View source]
def test_invoke_authorizer(input : AAG::TestInvokeAuthorizerRequest) : Core::ParsedResponse(AAG::TestInvokeAuthorizerResponse) #

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.


[View source]
def test_invoke_method(input : AAG::TestInvokeMethodRequest) : Core::ParsedResponse(AAG::TestInvokeMethodResponse) #

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.


[View source]
def untag_resource(input : AAG::UntagResourceRequest) : Core::Response #

Removes a tag from a given resource.


[View source]
def update_account(input : AAG::UpdateAccountRequest) : Core::ParsedResponse(AAG::Account) #

Changes information about the current Account resource.


[View source]
def update_api_key(input : AAG::UpdateApiKeyRequest) : Core::ParsedResponse(AAG::ApiKey) #

Changes information about an ApiKey resource.


[View source]
def update_authorizer(input : AAG::UpdateAuthorizerRequest) : Core::ParsedResponse(AAG::Authorizer) #

Updates an existing Authorizer resource.


[View source]
def update_base_path_mapping(input : AAG::UpdateBasePathMappingRequest) : Core::ParsedResponse(AAG::BasePathMapping) #

Changes information about the BasePathMapping resource.


[View source]
def update_client_certificate(input : AAG::UpdateClientCertificateRequest) : Core::ParsedResponse(AAG::ClientCertificate) #

Changes information about an ClientCertificate resource.


[View source]
def update_deployment(input : AAG::UpdateDeploymentRequest) : Core::ParsedResponse(AAG::Deployment) #

Changes information about a Deployment resource.


[View source]
def update_documentation_part(input : AAG::UpdateDocumentationPartRequest) : Core::ParsedResponse(AAG::DocumentationPart) #

Updates a documentation part.


[View source]
def update_documentation_version(input : AAG::UpdateDocumentationVersionRequest) : Core::ParsedResponse(AAG::DocumentationVersion) #

Updates a documentation version.


[View source]
def update_domain_name(input : AAG::UpdateDomainNameRequest) : Core::ParsedResponse(AAG::DomainName) #

Changes information about the DomainName resource.


[View source]
def update_gateway_response(input : AAG::UpdateGatewayResponseRequest) : Core::ParsedResponse(AAG::GatewayResponse) #

Updates a GatewayResponse of a specified response type on the given RestApi.


[View source]
def update_integration(input : AAG::UpdateIntegrationRequest) : Core::ParsedResponse(AAG::Integration) #

Represents an update integration.


[View source]
def update_integration_response(input : AAG::UpdateIntegrationResponseRequest) : Core::ParsedResponse(AAG::IntegrationResponse) #

Represents an update integration response.


[View source]
def update_method(input : AAG::UpdateMethodRequest) : Core::ParsedResponse(AAG::Method) #

Updates an existing Method resource.


[View source]
def update_method_response(input : AAG::UpdateMethodResponseRequest) : Core::ParsedResponse(AAG::MethodResponse) #

Updates an existing MethodResponse resource.


[View source]
def update_model(input : AAG::UpdateModelRequest) : Core::ParsedResponse(AAG::Model) #

Changes information about a model. The maximum size of the model is 400 KB.


[View source]
def update_request_validator(input : AAG::UpdateRequestValidatorRequest) : Core::ParsedResponse(AAG::RequestValidator) #

Updates a RequestValidator of a given RestApi.


[View source]
def update_resource(input : AAG::UpdateResourceRequest) : Core::ParsedResponse(AAG::Resource) #

Changes information about a Resource resource.


[View source]
def update_rest_api(input : AAG::UpdateRestApiRequest) : Core::ParsedResponse(AAG::RestApi) #

Changes information about the specified API.


[View source]
def update_stage(input : AAG::UpdateStageRequest) : Core::ParsedResponse(AAG::Stage) #

Changes information about a Stage resource.


[View source]
def update_usage(input : AAG::UpdateUsageRequest) : Core::ParsedResponse(AAG::Usage) #

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.


[View source]
def update_usage_plan(input : AAG::UpdateUsagePlanRequest) : Core::ParsedResponse(AAG::UsagePlan) #

Updates a usage plan of a given plan Id.


[View source]
def update_vpc_link(input : AAG::UpdateVpcLinkRequest) : Core::ParsedResponse(AAG::VpcLink) #

Updates an existing VpcLink of a specified identifier.


[View source]