API Gateway
| eventName | Description | Sample | Rule |
|---|---|---|---|
| any | Catch-all entry for API Gateway rules that match the service but not a specific eventName. | N | N |
| Get | Retrieves the details of a specific API key, including its value, associated usage plans, and enabled status. | Y | Y |
| Get | Lists all API keys in the account, optionally filtered by usage plan or name prefix, and optionally including key values. | Y | Y |
| Create | Creates an Api resource. | Y | N |
| Create | Create an ApiKey resource. | Y | N |
| Create | Creates an API mapping. | N | N |
| Create | Adds a new Authorizer resource to an existing RestApi resource. | Y | N |
| Create | Creates a new BasePathMapping resource. | N | N |
| Create | Creates a Deployment resource, which makes a specified RestApi callable over the internet. | Y | N |
| Create | Creates a documentation part. | Y | N |
| Create | Creates a documentation version | Y | N |
| Create | Creates a new domain name. | N | N |
| Create | Creates a domain name access association resource between an access association source and a private custom domain name. | N | N |
| Create | Creates an Integration. | Y | N |
| Create | Creates an IntegrationResponses. | N | N |
| Create | Adds a new Model resource to an existing RestApi resource. | Y | N |
| Create | Creates a portal. | N | N |
| Create | Creates a new portal product. | N | N |
| Create | Creates a new product page for a portal product. | N | N |
| Create | Creates a product REST endpoint page for a portal product. | N | N |
| Create | Creates a RequestValidator of a given RestApi. | Y | N |
| Create | Creates a Resource resource. | Y | N |
| Create | Creates a new RestApi resource. | Y | N |
| Create | Creates a Route for an API. | Y | N |
| Create | Creates a RouteResponse for a Route. | Y | N |
| Create | Creates a RoutingRule. | N | N |
| Create | Creates a new Stage resource that references a pre-existing Deployment for the API. | Y | N |
| Create | Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload. | Y | N |
| Create | Creates a usage plan key for adding an existing API key to a usage plan. | Y | N |
| Create | 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. | N | N |
| Delete | Deletes the AccessLogSettings for a Stage. | Y | N |
| Delete | Deletes an Api resource. | Y | N |
| Delete | Deletes the ApiKey resource. | Y | N |
| Delete | Deletes an API mapping. | Y | N |
| Delete | Deletes an existing Authorizer resource. | Y | N |
| Delete | Deletes the BasePathMapping resource. | Y | N |
| Delete | Deletes the ClientCertificate resource. | Y | N |
| Delete | Deletes a CORS configuration. | Y | N |
| Delete | Deletes a Deployment resource. | Y | N |
| Delete | Deletes a documentation part | Y | N |
| Delete | Deletes a documentation version. | Y | N |
| Delete | Deletes the DomainName resource. | Y | N |
| Delete | Deletes the DomainNameAccessAssociation resource. | N | N |
| Delete | Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings. | Y | N |
| Delete | Represents a delete integration. | Y | N |
| Delete | Represents a delete integration response. | Y | N |
| Delete | Deletes an existing Method resource. | Y | N |
| Delete | Deletes an existing MethodResponse resource. | Y | N |
| Delete | Deletes a model. | Y | N |
| Delete | Deletes a portal. | Y | N |
| Delete | Deletes a portal product. | Y | N |
| Delete | Deletes the sharing policy for a portal product. | Y | N |
| Delete | Deletes a product page of a portal product. | Y | N |
| Delete | Deletes a product REST endpoint page. | Y | N |
| Delete | Deletes a RequestValidator of a given RestApi. | Y | N |
| Delete | Deletes a Resource resource. | Y | N |
| Delete | Deletes the specified API. | Y | N |
| Delete | Deletes a Route. | Y | N |
| Delete | Deletes a route request parameter. | Y | N |
| Delete | Deletes a RouteResponse. | Y | N |
| Delete | Deletes the RouteSettings for a stage. | Y | N |
| Delete | Deletes a routing rule. | Y | N |
| Delete | Deletes a Stage resource. | Y | N |
| Delete | Deletes a usage plan of a given plan Id. | Y | N |
| Delete | Deletes a usage plan key and remove the underlying API key from the associated usage plan. | Y | N |
| Delete | Deletes an existing VpcLink of a specified identifier. | Y | N |
| Disable | Deletes the publication of a portal portal. | Y | N |
| Export | ExportApi API operation for Amazon API Gateway. | Y | N |
| Flush | Flushes all authorizer cache entries on a stage. | Y | N |
| Flush | Flushes a stage's cache. | N | N |
| Generate | Generates a ClientCertificate resource. | Y | N |
| Get | Gets information about the current Account resource. | Y | N |
| Get | Gets an Api resource. | Y | N |
| Get | Gets an API mapping. | Y | N |
| Get | Gets API mappings. | Y | N |
| Get | Gets a collection of Api resources. | Y | N |
| Get | Describe an existing Authorizer resource. | Y | N |
| Get | Describe an existing Authorizers resource. | Y | N |
| Get | Describe a BasePathMapping resource. | Y | N |
| Get | Represents a collection of BasePathMapping resources. | Y | N |
| Get | Gets information about the current ClientCertificate resource. | Y | N |
| Get | Gets a collection of ClientCertificate resources. | Y | N |
| Get | Gets information about a Deployment resource. | Y | N |
| Get | Gets information about a Deployments collection. | Y | N |
| Get | Gets a documentation part. | Y | N |
| Get | Gets documentation parts. | Y | N |
| Get | Gets a documentation version. | Y | N |
| Get | Gets documentation versions. | Y | N |
| Get | Represents a domain name that is contained in a simpler, more intuitive URL that can be called. | Y | N |
| Get | Represents a collection on DomainNameAccessAssociations resources. | Y | N |
| Get | Represents a collection of DomainName resources. | Y | N |
| Get | Exports a deployed version of a RestApi in a specified format. | Y | N |
| Get | Gets a GatewayResponse of a specified response type on the given RestApi. | Y | N |
| Get | Gets the GatewayResponses collection on the given RestApi. | Y | N |
| Get | Get the integration settings. | Y | N |
| Get | Represents a get integration response. | Y | N |
| Get | Gets the IntegrationResponses for an Integration. | Y | N |
| Get | Gets the Integrations for an API. | Y | N |
| Get | Describe an existing Method resource. | Y | N |
| Get | Describes a MethodResponse resource. | Y | N |
| Get | Describes an existing model defined for a RestApi resource. | Y | N |
| Get | Describes existing Models defined for a RestApi resource. | Y | N |
| Get | Generates a sample mapping template that can be used to transform a payload into the structure of a model. | Y | N |
| Get | Gets a portal. | Y | N |
| Get | Gets a portal product. | Y | N |
| Get | Gets the sharing policy for a portal product. | Y | N |
| Get | Gets a product page of a portal product. | Y | N |
| Get | Gets a product REST endpoint page. | Y | N |
| Get | Gets a RequestValidator of a given RestApi. | Y | N |
| Get | Gets the RequestValidators collection of a given RestApi. | Y | N |
| Get | Lists information about a resource. | Y | N |
| Get | Lists information about a collection of Resource resources. | Y | N |
| Get | Lists the RestApi resource in the collection. | Y | N |
| Get | Lists the RestApis resources for your collection. | Y | N |
| Get | Gets a Route. | Y | N |
| Get | Gets a RouteResponse. | Y | N |
| Get | Gets the RouteResponses for a Route. | Y | N |
| Get | Gets the Routes for an API. | Y | N |
| Get | Gets a routing rule. | Y | N |
| Get | Generates a client SDK for a RestApi and Stage. | Y | N |
| Get | Gets an SDK type. | Y | N |
| Get | Gets SDK types | Y | N |
| Get | Gets information about a Stage resource. | Y | N |
| Get | Gets information about one or more Stage resources. | Y | N |
| Get | Gets the Tags collection for a given resource. | Y | N |
| Get | Gets the usage data of a usage plan in a specified time interval. | Y | N |
| Get | Gets a usage plan of a given plan identifier. | Y | N |
| Get | Gets a usage plan key of a given key identifier. | Y | N |
| Get | Gets all the usage plan keys representing the API keys added to a specified usage plan. | Y | N |
| Get | Gets all the usage plans of the caller's account. | Y | N |
| Get | Gets a specified VPC link under the caller's account in a region. | Y | N |
| Get | Gets the VpcLinks collection under the caller's account in a selected region. | Y | N |
| Import | Imports an API. | Y | N |
| Import | Import API keys from an external source, such as a CSV-formatted file. | Y | N |
| Import | Imports documentation parts | Y | N |
| Import | A feature of the API Gateway control service for creating a new API from an external API definition file. | Y | N |
| List | Lists portal products. | Y | N |
| List | Lists portals. | Y | N |
| List | Lists the product pages for a portal product. | Y | N |
| List | Lists the product REST endpoint pages of a portal product. | Y | N |
| List | Lists routing rules. | Y | N |
| Preview | Creates a portal preview. | N | N |
| Publish | Publishes a portal. | N | N |
| Put | Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi. | Y | N |
| Put | Sets up a method's integration. | Y | N |
| Put | Represents a put integration. | Y | N |
| Put | Add a method to an existing Resource resource. | Y | N |
| Put | Adds a MethodResponse to an existing Method resource. | Y | N |
| Put | Updates the sharing policy for a portal product. | N | N |
| Put | A feature of the API Gateway control service for updating an existing API with an input of external API definitions. | Y | N |
| Put | Updates a routing rule. | N | N |
| Reimport | Puts an Api resource. | Y | N |
| Reject | Rejects a domain name access association with a private custom domain name. | N | N |
| Reset | Resets all authorizer cache entries on a stage. | Y | N |
| Tag | Adds or updates a tag on a given resource. | Y | N |
| Test | Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. | N | N |
| Test | Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body. | N | N |
| Untag | Removes a tag from a given resource. | Y | N |
| Update | Changes information about the current Account resource. | Y | N |
| Update | Updates an Api resource. | Y | N |
| Update | Changes information about an ApiKey resource. | Y | N |
| Update | The API mapping. | Y | N |
| Update | Updates an existing Authorizer resource. | Y | N |
| Update | Changes information about the BasePathMapping resource. | Y | N |
| Update | Changes information about an ClientCertificate resource. | Y | N |
| Update | Changes information about a Deployment resource. | Y | N |
| Update | Updates a documentation part. | Y | N |
| Update | Updates a documentation version. | Y | N |
| Update | Changes information about the DomainName resource. | Y | N |
| Update | Updates a GatewayResponse of a specified response type on the given RestApi. | Y | N |
| Update | Represents an update integration. | Y | N |
| Update | Represents an update integration response. | Y | N |
| Update | Updates an existing Method resource. | Y | N |
| Update | Updates an existing MethodResponse resource. | Y | N |
| Update | Changes information about a model. | Y | N |
| Update | Updates a portal. | Y | N |
| Update | Updates the portal product. | Y | N |
| Update | Updates a product page of a portal product. | Y | N |
| Update | Updates a product REST endpoint page. | Y | N |
| Update | Updates a RequestValidator of a given RestApi. | Y | N |
| Update | Changes information about a Resource resource. | Y | N |
| Update | Changes information about the specified API. | Y | N |
| Update | Updates a Route. | Y | N |
| Update | Updates a RouteResponse. | Y | N |
| Update | Changes information about a Stage resource. | Y | N |
| Update | Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key. | Y | N |
| Update | Updates a usage plan of a given plan Id. | Y | N |
| Update | Updates an existing VpcLink of a specified identifier. | Y | N |
any: API Gateway (catch-all)
#Description
Catch-all entry for API Gateway rules that match the service but not a specific eventName.
GetApiKey
#Description
Retrieves the details of a specific API key, including its value, associated usage plans, and enabled status.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "24aff797-cc56-4c17-a443-e47a226117e30",
"eventName": "GetApiKey",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:19:25Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "b674160a6-f6e0-11e6-a8fd-45f7b8654c2c",
"requestParameters": {
"apiKey": "h0fh6siai6",
"includeValue": false,
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
Detection Rules #
Full rule details for this event, including ATT&CK technique mappings and native queries →YARA-L #
T1555↳ also matches GetApiKeys
References #
GetApiKeys
#Description
Lists all API keys in the account, optionally filtered by usage plan or name prefix, and optionally including key values.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "cef58f95-542f-4f5e-b4fe-f7f1f0aa849a",
"eventName": "GetApiKeys",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:18:54Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "a292dddf-f6e0-11e6-8c58-ed8c770152b95",
"requestParameters": {
"limit": 50,
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
Detection Rules #
Full rule details for this event, including ATT&CK technique mappings and native queries →YARA-L #
T1555↳ also matches GetApiKey
References #
CreateApi
#Description
Creates an Api resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "faec5e25-0b84-4dad-a79d-8fa4686aeb1e",
"eventName": "CreateApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:17Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "366d4bbc-3bf4-49a9-8833-8f00b3e8608f",
"requestParameters": {
"description": "dwfix HTTP API",
"name": "dwfix-http-api",
"protocolType": "HTTP"
},
"responseElements": {
"apiEndpoint": "https://j4sinjzb1c.execute-api.us-west-1.amazonaws.com",
"apiId": "j4sinjzb1c",
"apiKeySelectionExpression": "$request.header.x-api-key",
"createdDate": "2026-06-29T20:59:17Z",
"description": "dwfix HTTP API",
"disableExecuteApiEndpoint": false,
"ipAddressType": "ipv4",
"name": "dwfix-http-api",
"protocolType": "HTTP",
"routeSelectionExpression": "$request.method $request.path"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateApiKey
#Description
Create an ApiKey resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "c993327-7f27-4b99-b083-8624e69ce945",
"eventName": "CreateApiKey",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:19:25Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "b5115ce4-f6e0-11e6-a8fd-45f7b8654c2c",
"requestParameters": {
"createApiKeyInput": {
"description": "prod",
"enabled": true,
"generateDistinctId": true,
"name": "prod"
},
"template": false
},
"responseElements": {
"apikeyDelete": {
"apiKey": "h0fh6siai6",
"template": false
},
"apikeyUpdate": {
"apiKey": "h0fh6siai6",
"template": false
},
"apikeyUsageplans": {
"keyId": "h0fh6siai6",
"template": false
},
"createdDate": "Feb 19, 2017 8:19:25 PM",
"description": "prod",
"enabled": true,
"id": "h0fh6siai6",
"lastUpdatedDate": "Feb 19, 2017 8:19:25 PM",
"name": "prod",
"self": {
"apiKey": "h0fh6siai6",
"template": false
},
"stageKeys": [],
"usageplanById": {
"template": true
},
"value": "**********************************vy6LA5"
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
CreateApiMapping
#Description
Creates an API mapping.
CreateBasePathMapping
#Description
Creates a new BasePathMapping resource.
CreateDeployment
#Description
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "d57883cd-5b7d-40f0-8b30-999740c1ff5",
"eventName": "CreateDeployment",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:54Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "133c12a2-f6e0-11e6-9820-77f78e073058b",
"requestParameters": {
"createDeploymentInput": {
"description": "Deployed by AWS Lambda",
"stageDescription": "Created by AWS Lambda",
"stageName": "prod"
},
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": {
"createdDate": "Feb 19, 2017 8:14:54 PM",
"deploymentDelete": {
"deploymentId": "336ckg",
"restApiId": "oqqw7yl1k8",
"template": false
},
"deploymentStages": {
"deploymentId": "336ckg",
"restApiId": "oqqw7yl1k8",
"template": false,
"templateSkipList": [
"position"
]
},
"deploymentUpdate": {
"deploymentId": "336ckg",
"restApiId": "oqqw7yl1k8",
"template": false
},
"description": "Deployed by AWS Lambda",
"id": "336ckg",
"self": {
"deploymentId": "336ckg",
"restApiId": "oqqw7yl1k8",
"template": false
}
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
CreateDocumentationPart
#Description
Creates a documentation part.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "6442b82a-bcf9-4b85-96bd-a5dc7a074c75",
"eventName": "CreateDocumentationPart",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:14Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "652780ac-8107-42af-9904-69ff4be6d459",
"requestParameters": {
"createDocumentationPartInput": {
"location": {
"type": "API"
},
"properties": {
"description": "dwfix REST API"
}
},
"restApiId": "3vn2gv80s2",
"template": false
},
"responseElements": {
"documentationpartDelete": {
"documentationPartId": "pd46ca",
"restApiId": "3vn2gv80s2",
"template": false
},
"documentationpartUpdate": {
"documentationPartId": "pd46ca",
"restApiId": "3vn2gv80s2",
"template": false
},
"id": "pd46ca",
"location": {
"type": "API"
},
"properties": {
"description": "dwfix REST API"
},
"self": {
"documentationPartId": "pd46ca",
"restApiId": "3vn2gv80s2",
"template": false
}
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateDocumentationVersion
#Description
Creates a documentation version
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "8ad96f5b-e3eb-45cd-86e4-80fb4b927414",
"eventName": "CreateDocumentationVersion",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:15Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "e09ae5f6-304b-44bf-983b-ed63758e6deb",
"requestParameters": {
"createDocumentationVersionInput": {
"description": "dwfix docs v1",
"documentationVersion": "v1",
"stageName": "dwfixstage"
},
"restApiId": "3vn2gv80s2",
"template": false
},
"responseElements": {
"createdDate": "Jun 29, 2026 8:59:15 PM",
"description": "dwfix docs v1",
"documentationversionDelete": {
"documentationVersion": "v1",
"restApiId": "3vn2gv80s2",
"template": false
},
"documentationversionUpdate": {
"documentationVersion": "v1",
"restApiId": "3vn2gv80s2",
"template": false
},
"self": {
"documentationVersion": "v1",
"restApiId": "3vn2gv80s2",
"template": false
},
"version": "v1"
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateDomainName
#Description
Creates a new domain name.
CreateDomainNameAccessAssociation
#Description
Creates a domain name access association resource between an access association source and a private custom domain name.
CreateIntegration
#Description
Creates an Integration.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "73575ae0-b0fa-4ad3-9dfb-6154272bcbaa",
"eventName": "CreateIntegration",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:17Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "6f8d010d-7545-4a39-8153-0d1284c10938",
"requestParameters": {
"apiId": "j4sinjzb1c",
"description": "dwfix mock integration",
"integrationType": "MOCK"
},
"responseElements": {
"message": "Currently, an API with a protocol type of HTTP may only be associated with proxy integrations (AWS_PROXY, HTTP_PROXY)"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateIntegrationResponse
#Description
Creates an IntegrationResponses.
CreateModel
#Description
Adds a new Model resource to an existing RestApi resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "77e90c33-c3b2-4ab5-89eb-f09f9582b50f",
"eventName": "CreateModel",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:00:55Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "04ecae9f-bde0-4906-8027-0144f11aae4d",
"requestParameters": {
"createModelInput": {
"contentType": "application/json",
"name": "dwModel",
"schema": {
"type": "object"
}
},
"restApiId": "h4kjgdo8oh",
"template": false
},
"responseElements": {
"contentType": "application/json",
"id": "u5kbsx",
"modelCreate": {
"restApiId": "h4kjgdo8oh",
"template": false
},
"modelDelete": {
"modelName": "dwModel",
"restApiId": "h4kjgdo8oh",
"template": false
},
"modelGenerateTemplate": {
"modelName": "dwModel",
"restApiId": "h4kjgdo8oh",
"template": false
},
"modelUpdate": {
"modelName": "dwModel",
"restApiId": "h4kjgdo8oh",
"template": false
},
"name": "dwModel",
"schema": {
"type": "object"
},
"self": {
"flatten": false,
"modelName": "dwModel",
"restApiId": "h4kjgdo8oh",
"template": false
}
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/b,D,Z cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreatePortal
#Description
Creates a portal.
CreatePortalProduct
#Description
Creates a new portal product.
CreateProductPage
#Description
Creates a new product page for a portal product.
CreateProductRestEndpointPage
#Description
Creates a product REST endpoint page for a portal product.
CreateRequestValidator
#Description
Creates a RequestValidator of a given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "e53c28f6-b0a4-48f0-8b27-7ae6135eac4e",
"eventName": "CreateRequestValidator",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:14Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "82d50121-413a-440c-8cf4-72637422ffe8",
"requestParameters": {
"createRequestValidatorInput": {
"name": "dwfix-validator",
"validateRequestBody": false,
"validateRequestParameters": true
},
"restApiId": "3vn2gv80s2",
"template": false
},
"responseElements": {
"id": "e9g23g",
"name": "dwfix-validator",
"requestvalidatorDelete": {
"requestValidatorId": "e9g23g",
"restApiId": "3vn2gv80s2",
"template": false
},
"requestvalidatorUpdate": {
"requestValidatorId": "e9g23g",
"restApiId": "3vn2gv80s2",
"template": false
},
"self": {
"requestValidatorId": "e9g23g",
"restApiId": "3vn2gv80s2",
"template": false
},
"validateRequestBody": false,
"validateRequestParameters": true
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateResource
#Description
Creates a Resource resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "f4ad10ce-10a4-4aab-b836-a499c3caae92",
"eventName": "CreateResource",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:53Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "1311ce26-f6e0-11e6-b61a-4a33e1aa6d10",
"requestParameters": {
"createResourceInput": {
"pathPart": "level6-ec1335a148b902503664e2d162fcdaa98c224ea5"
},
"parentId": "g6aescputd",
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": {
"id": "cgwh6i",
"methodByHttpMethod": {
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": true
},
"methodPut": {
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": true
},
"parentId": "g6aescputd",
"path": "/level6-ec1335a148b902503664e2d162fcdaa98c224ea5",
"pathPart": "level6-ec1335a148b902503664e2d162fcdaa98c224ea5",
"resourceCreateChild": {
"parentId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"resourceDelete": {
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"resourceUpdate": {
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"self": {
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
}
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
CreateRestApi
#Description
Creates a new RestApi resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "ea4034c5-5a37-4f4a-91ac-1f1b6d4bf152",
"eventName": "CreateRestApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:53Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "12dcdb9c-f6e0-11e6-9820-77f78e073058b",
"requestParameters": {
"createRestApiInput": {
"description": "Created by AWS Lambda",
"name": "LambdaMicroservice"
},
"template": false
},
"responseElements": {
"authorizerById": {
"restApiId": "oqqw7yl1k8",
"template": true
},
"authorizerCreate": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"createdDate": "Feb 19, 2017 8:14:53 PM",
"deploymentById": {
"restApiId": "oqqw7yl1k8",
"template": true,
"templateSkipList": [
"position"
]
},
"deploymentCreate": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"description": "Created by AWS Lambda",
"documentationpartById": {
"restApiId": "oqqw7yl1k8",
"template": true
},
"documentationpartCreate": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"documentationpartImport": {
"failOnWarnings": false,
"restApiId": "oqqw7yl1k8",
"template": true
},
"documentationversionByVersion": {
"restApiId": "oqqw7yl1k8",
"template": true
},
"documentationversionCreate": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"id": "oqqw7yl1k8",
"modelByName": {
"flatten": false,
"restApiId": "oqqw7yl1k8",
"template": true
},
"modelCreate": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"name": "LambdaMicroservice",
"resourceById": {
"restApiId": "oqqw7yl1k8",
"template": true
},
"resourceCreate": {
"parentId": "g6aescputd",
"restApiId": "oqqw7yl1k8",
"template": false
},
"restapiAuthorizers": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"restapiDelete": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"restapiDeployments": {
"restApiId": "oqqw7yl1k8",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiDocumentationParts": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"restapiDocumentationVersions": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"restapiModels": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"restapiResources": {
"restApiId": "oqqw7yl1k8",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiStages": {
"restApiId": "oqqw7yl1k8",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiUpdate": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"self": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"stageByName": {
"restApiId": "oqqw7yl1k8",
"template": true
},
"stageCreate": {
"restApiId": "oqqw7yl1k8",
"template": false
}
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
CreateRoute
#Description
Creates a Route for an API.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "30facee6-e9d6-4de3-b8a9-cd3d8bd5629a",
"eventName": "CreateRoute",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:17Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "c3a04701-7152-4572-99bc-6c0b73f322d0",
"requestParameters": {
"apiId": "j4sinjzb1c",
"authorizationType": "NONE",
"routeKey": "GET /dwfix"
},
"responseElements": {
"apiKeyRequired": false,
"authorizationType": "NONE",
"routeId": "8v3d8le",
"routeKey": "GET /dwfix"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateRouteResponse
#Description
Creates a RouteResponse for a Route.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "37ae63ef-1fbc-40ba-8326-afead5fd5d08",
"eventName": "CreateRouteResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:17Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "7a0aed59-586f-4411-bb60-987e66d06064",
"requestParameters": {
"apiId": "j4sinjzb1c",
"routeId": "8v3d8le",
"routeResponseKey": "$default"
},
"responseElements": {
"message": "RouteResponses are currently not supported for this API protocol type. This is because the API may only be configured with proxy integration at this time."
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateRoutingRule
#Description
Creates a RoutingRule.
CreateStage
#Description
Creates a new Stage resource that references a pre-existing Deployment for the API.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "f4ba0734-8610-44aa-a738-f877112c28ea2",
"eventName": "CreateStage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T21:01:07Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "8878d571-f6e6-11e6-8c58-ed8c770152b95",
"requestParameters": {
"createStageInput": {
"cacheClusterEnabled": false,
"deploymentId": "moil8t",
"description": "",
"stageName": "Level5"
},
"restApiId": "pvlftmiyea",
"template": false
},
"responseElements": {
"cacheClusterEnabled": false,
"cacheClusterStatus": "NOT_AVAILABLE",
"createdDate": "Feb 19, 2017 9:01:07 PM",
"deploymentId": "moil8t",
"lastUpdatedDate": "Feb 19, 2017 9:01:07 PM",
"methodSettings": {},
"self": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
},
"stageDelete": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
},
"stageFlushAuthorizerCache": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
},
"stageName": "Level5",
"stageUpdate": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
}
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
CreateUsagePlan
#Description
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "593cb6a6-90ae-4676-b46e-1fbdaa68fd1a",
"eventName": "CreateUsagePlan",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:20:38Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "e05d3286-f6e0-11e6-9820-77f78e073058b",
"requestParameters": {
"createUsagePlanInput": {
"description": "prod",
"name": "Prod",
"quota": {
"limit": 10000,
"offset": 0,
"period": "DAY"
},
"throttle": {
"burstLimit": 100,
"rateLimit": 100
}
},
"template": false
},
"responseElements": {
"apiStages": [],
"description": "prod",
"id": "lqxj5e",
"name": "Prod",
"quota": {
"limit": 10000,
"offset": 0,
"period": "DAY"
},
"self": {
"template": false,
"usagePlanId": "lqxj5e"
},
"throttle": {
"burstLimit": 100,
"rateLimit": 100
},
"usageGet": {
"endDate": "2017-02-19",
"startDate": "2017-01-20",
"template": false,
"usagePlanId": "lqxj5e"
},
"usageplanDelete": {
"template": false,
"usagePlanId": "lqxj5e"
},
"usageplanUpdate": {
"template": false,
"usagePlanId": "lqxj5e"
},
"usageplanUsageplankeys": {
"template": false,
"usagePlanId": "lqxj5e"
},
"usageplankeyCreate": {
"template": false,
"usagePlanId": "lqxj5e"
}
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
CreateUsagePlanKey
#Description
Creates a usage plan key for adding an existing API key to a usage plan.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "9631e659-c32f-4c95-b104-a33cae7b1267",
"eventName": "CreateUsagePlanKey",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:00:56Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "3b94737f-6928-4ea3-9e70-a303ae8b2960",
"requestParameters": {
"createUsagePlanKeyInput": {
"keyId": "f8js95yqb8",
"keyType": "API_KEY"
},
"template": false,
"usagePlanId": "qlkjlg"
},
"responseElements": {
"id": "f8js95yqb8",
"name": "dwfix-key",
"self": {
"keyId": "f8js95yqb8",
"template": false,
"usagePlanId": "qlkjlg"
},
"type": "API_KEY",
"usageplankeyDelete": {
"keyId": "f8js95yqb8",
"template": false,
"usagePlanId": "qlkjlg"
},
"value": "**********************************BFXod0"
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/b,D,Z cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
CreateVpcLink
#Description
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.
DeleteAccessLogSettings
#Description
Deletes the AccessLogSettings for a Stage.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "0e61fc93-abc9-4e95-890c-6f99919a1648",
"eventName": "DeleteAccessLogSettings",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "920383c5-145f-4bdf-bd44-c6aa18ebf5a1",
"requestParameters": {
"apiId": "dw-probe",
"stageName": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteApi
#Description
Deletes an Api resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "22acab09-6677-4892-a4f3-585a9fb75132",
"eventName": "DeleteApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "fe67b4eb-cfad-46b2-a69f-6f8459babe1f",
"requestParameters": {
"apiId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteApiKey
#Description
Deletes the ApiKey resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid API Key identifier specified",
"eventCategory": "Management",
"eventID": "e433cb8b-02d1-467d-a749-b7f6b3fd924c",
"eventName": "DeleteApiKey",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "70c50be1-266b-422a-a40a-db2d6adc60ff",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteApiMapping
#Description
Deletes an API mapping.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "14545b43-0f9f-4183-8276-1d6816fe04e1",
"eventName": "DeleteApiMapping",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "de8f4a41-d6e3-445d-b4fa-a8b5b779e056",
"requestParameters": {
"apiMappingId": "dw-probe",
"domainName": "dw-probe"
},
"responseElements": {
"message": "Invalid domain name identifier specified"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteBasePathMapping
#Description
Deletes the BasePathMapping resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid domain name identifier specified",
"eventCategory": "Management",
"eventID": "1ad26d18-40ef-4313-bd52-2c1d4030f0d9",
"eventName": "DeleteBasePathMapping",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "50849243-740b-4829-b88e-ef0d959e5d9e",
"requestParameters": {
"basePath": "dw-probe",
"domainName": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteClientCertificate
#Description
Deletes the ClientCertificate resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid client certificate id specified",
"eventCategory": "Management",
"eventID": "a76bd681-871f-4a5b-b3e4-e0339b2ca35a",
"eventName": "DeleteClientCertificate",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "c8a279ca-2e00-4cd1-9ea8-299680bf598b",
"requestParameters": {
"clientCertificateId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteCorsConfiguration
#Description
Deletes a CORS configuration.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "2377fdcf-f338-4d16-abf6-6a8d2c04c1cf",
"eventName": "DeleteCorsConfiguration",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "7bcb1d09-3c19-4651-8c7f-adea6148e3b6",
"requestParameters": {
"apiId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteDeployment
#Description
Deletes a Deployment resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Deployment identifier specified",
"eventCategory": "Management",
"eventID": "93e8af2b-a4a1-42a1-a97a-f1820bcb5da8",
"eventName": "DeleteDeployment",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "d4cab449-2021-4f52-bea7-144aec184e58",
"requestParameters": {
"deploymentId": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteDocumentationPart
#Description
Deletes a documentation part
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid API identifier specified 123456789012:dw-probe",
"eventCategory": "Management",
"eventID": "1a212c41-f2b4-4a0a-8ff2-48b771fd58bb",
"eventName": "DeleteDocumentationPart",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "7b14d61c-70a7-4ff2-a235-e1029365ba1f",
"requestParameters": {
"documentationPartId": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteDocumentationVersion
#Description
Deletes a documentation version.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Documentation version specified",
"eventCategory": "Management",
"eventID": "bd284d8c-0900-403c-8560-f28b0b9e5e77",
"eventName": "DeleteDocumentationVersion",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "b21ead1a-8101-4e1b-9697-ed290785af0f",
"requestParameters": {
"documentationVersion": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteDomainName
#Description
Deletes the DomainName resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid domain name identifier specified",
"eventCategory": "Management",
"eventID": "6ee2655b-5057-4db2-be7e-f18d0032ed52",
"eventName": "DeleteDomainName",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "743208d8-a3e5-4cf4-ae4c-d6a4a4cc3226",
"requestParameters": {
"domainName": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteDomainNameAccessAssociation
#Description
Deletes the DomainNameAccessAssociation resource.
DeleteGatewayResponse
#Description
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid API identifier specified 123456789012:dw-probe",
"eventCategory": "Management",
"eventID": "01bf6e92-d60e-4a1e-b97f-a39db4f1f740",
"eventName": "DeleteGatewayResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "a2947b62-e223-4268-b50e-fd985aef50be",
"requestParameters": {
"responseType": "DEFAULT_4XX",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteIntegration
#Description
Represents a delete integration.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Resource identifier specified",
"eventCategory": "Management",
"eventID": "df892250-929c-4c74-b9c5-000aa7f2f887",
"eventName": "DeleteIntegration",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "d9868ebb-605b-4142-9fe7-83367fe8603b",
"requestParameters": {
"httpMethod": "dw-probe",
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteIntegrationResponse
#Description
Represents a delete integration response.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "ValidationException",
"errorMessage": "1 validation error detected: Value 'dw-probe' at 'statusCode' failed to satisfy constraint: Member must satisfy regular expression pattern: [1-5]\\d\\d",
"eventCategory": "Management",
"eventID": "1c08e02e-89f2-45d2-9c9d-287bb97e7ac2",
"eventName": "DeleteIntegrationResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "9770d3ec-c668-47c5-b113-cdd615e5169e",
"requestParameters": {
"httpMethod": "dw-probe",
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"statusCode": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteMethod
#Description
Deletes an existing Method resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "f3e5e93a-d5bf-41ad-a0cf-6bebd67af2f3",
"eventName": "DeleteMethod",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:59:12Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "964532f-f6e6-11e6-8c58-ed8c770152b95",
"requestParameters": {
"httpMethod": "GET",
"resourceId": "1er7ndd5j0",
"restApiId": "pvlftmiyea",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
DeleteMethodResponse
#Description
Deletes an existing MethodResponse resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "ValidationException",
"errorMessage": "1 validation error detected: Value 'dw-probe' at 'statusCode' failed to satisfy constraint: Member must satisfy regular expression pattern: [1-5]\\d\\d",
"eventCategory": "Management",
"eventID": "4392d9f2-0a6c-410a-b5b4-0e2bf536314a",
"eventName": "DeleteMethodResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "7dc10b6b-3c5f-4e8f-96a6-32b6b63f05bc",
"requestParameters": {
"httpMethod": "dw-probe",
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"statusCode": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteModel
#Description
Deletes a model.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid model name specified: dw-probe",
"eventCategory": "Management",
"eventID": "bfa98cbd-65ec-4bdb-ae1d-9b1a3a99aa1b",
"eventName": "DeleteModel",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "e573c44c-e3fd-4852-a121-3d6fd882f84b",
"requestParameters": {
"modelName": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeletePortal
#Description
Deletes a portal.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "d967d462-dbeb-4b7e-abf2-8e91b95afa28",
"eventName": "DeletePortal",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "6aff2164-4e20-4db8-9b01-f3a0d293c05c",
"requestParameters": {
"portalId": "dw-probe"
},
"responseElements": {
"message": "2 validation errors detected: Value 'dw-probe' at 'portalId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeletePortalProduct
#Description
Deletes a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "da3ecd95-e558-4080-b3df-b4255c0b3c09",
"eventName": "DeletePortalProduct",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "f56ed550-ea03-4e9c-8646-1a7b18c98699",
"requestParameters": {
"portalProductId": "dw-probe"
},
"responseElements": {
"message": "2 validation errors detected: Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeletePortalProductSharingPolicy
#Description
Deletes the sharing policy for a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "9f5c888b-63b6-4c5a-ab48-59bca81fc045",
"eventName": "DeletePortalProductSharingPolicy",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "1943620e-c7ee-4afe-8f20-11687855966b",
"requestParameters": {
"portalProductId": "dw-probe"
},
"responseElements": {
"message": "2 validation errors detected: Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteProductPage
#Description
Deletes a product page of a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "c668b04b-43c4-4e74-91f9-2b3521f17904",
"eventName": "DeleteProductPage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "c383079b-b4e4-47b5-905a-3e4ce834115a",
"requestParameters": {
"portalProductId": "dw-probe",
"productPageId": "dw-probe"
},
"responseElements": {
"message": "4 validation errors detected: Value 'dw-probe' at 'productPageId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'productPageId' failed to satisfy constraint: Member must have length greater than or equal to 10; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteProductRestEndpointPage
#Description
Deletes a product REST endpoint page.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "fcd1ec00-1464-4e75-8828-7e6d0be7479e",
"eventName": "DeleteProductRestEndpointPage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "1de99e8a-0087-4ec0-b3e3-29d42e044446",
"requestParameters": {
"portalProductId": "dw-probe",
"productRestEndpointPageId": "dw-probe"
},
"responseElements": {
"message": "4 validation errors detected: Value 'dw-probe' at 'productRestEndpointPageId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'productRestEndpointPageId' failed to satisfy constraint: Member must have length greater than or equal to 10; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteRequestValidator
#Description
Deletes a RequestValidator of a given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Request Validator identifier specified",
"eventCategory": "Management",
"eventID": "79d92d9c-da7a-45f5-bee4-45d9ff12d83e",
"eventName": "DeleteRequestValidator",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "63f595e6-8c59-4e66-9d41-7667ce69f62b",
"requestParameters": {
"requestValidatorId": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteResource
#Description
Deletes a Resource resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "c88657c-3e8c-4703-bf9d-2320582f8aff",
"eventName": "DeleteResource",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-26T23:59:00Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "8abd0c0a-fc7f-11e6-843c-9dca9eba1047",
"requestParameters": {
"resourceId": "9bhbfa",
"restApiId": "puspzvwgb6",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAHNXISLUUAY64GZPM",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-26T17:48:22Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
DeleteRestApi
#Description
Deletes the specified API.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "74b4d2ff-91e6-423d-a9eb-13efa74c9172",
"eventName": "DeleteRestApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:35:59Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "60973-f6e3-11e6-bb27-97de9e670e63",
"requestParameters": {
"restApiId": "mu80it4vd6",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
DeleteRoute
#Description
Deletes a Route.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "15ce8edc-3b1f-45f2-b8bf-ac24735a2c0f",
"eventName": "DeleteRoute",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "cef0109b-94ee-43a4-8dfb-c942556c184a",
"requestParameters": {
"apiId": "dw-probe",
"routeId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteRouteRequestParameter
#Description
Deletes a route request parameter.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "2d6f3578-67ad-4c02-8831-7f17c68fd383",
"eventName": "DeleteRouteRequestParameter",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "35aca42b-4ef1-4fa4-bffe-508ece7399e8",
"requestParameters": {
"apiId": "dw-probe",
"requestParameterKey": "dw-probe",
"routeId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteRouteResponse
#Description
Deletes a RouteResponse.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "5526f8db-115c-425e-b3e6-08e05612cfb7",
"eventName": "DeleteRouteResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "d1478cd6-ad6a-4837-a8c3-89021e22ed9c",
"requestParameters": {
"apiId": "dw-probe",
"routeId": "dw-probe",
"routeResponseId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteRouteSettings
#Description
Deletes the RouteSettings for a stage.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "1e777768-3774-4676-8614-d8eff4363df3",
"eventName": "DeleteRouteSettings",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "4ef29bf3-f589-4943-812b-460ef3368207",
"requestParameters": {
"apiId": "dw-probe",
"routeKey": "dw-probe",
"stageName": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteRoutingRule
#Description
Deletes a routing rule.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "6cf52929-10c2-40b0-8d58-dd3a8495ddec",
"eventName": "DeleteRoutingRule",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "c510b210-5fcd-450e-b603-c4c855dea6b7",
"requestParameters": {
"domainName": "dw-probe",
"routingRuleId": "dw-probe"
},
"responseElements": {
"message": "Invalid domain name identifier specified"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteStage
#Description
Deletes a Stage resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "e6024b11-b140-4c05-8afb-03db4d610d66",
"eventName": "DeleteStage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T21:01:20Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "906c33e6-f6e6-11e6-9820-77f78e073058b",
"requestParameters": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
DeleteUsagePlan
#Description
Deletes a usage plan of a given plan Id.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "285a0847-4a80-428f-8e0f-94cffa823f90",
"eventName": "DeleteUsagePlan",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:46:33Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "7f5a7690-f6e4-11e6-90bc-baceba3c05e0",
"requestParameters": {
"template": false,
"usagePlanId": "lqxj5e"
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
DeleteUsagePlanKey
#Description
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid API Key identifier specified",
"eventCategory": "Management",
"eventID": "82f617bb-f578-4ae5-84d3-ffa68cbf3df9",
"eventName": "DeleteUsagePlanKey",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "b77a3e2e-f959-4aba-a0fe-d4f7fa00421b",
"requestParameters": {
"keyId": "dw-probe",
"template": false,
"usagePlanId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DeleteVpcLink
#Description
Deletes an existing VpcLink of a specified identifier.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Vpc Link identifier specified",
"eventCategory": "Management",
"eventID": "23e6ed5f-a83f-4b2d-a8df-d7fa7e6bbc4e",
"eventName": "DeleteVpcLink",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "4546699b-a2a4-49e7-851e-9f5ce2f3454f",
"requestParameters": {
"template": false,
"vpcLinkId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
DisablePortal
#Description
Deletes the publication of a portal portal.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "9a845b71-a433-42b6-8f74-77b5398785d4",
"eventName": "DisablePortal",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "32da065d-b1ee-47e9-b2e3-2bb992516af1",
"requestParameters": {
"portalId": "dw-probe"
},
"responseElements": {
"message": "2 validation errors detected: Value 'dw-probe' at 'portalId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ExportApi
#Description
ExportApi API operation for Amazon API Gateway.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "a582ec9c-9c69-4f46-bf8d-9e552c6c62b7",
"eventName": "ExportApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:19Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "c0a43654-f308-4959-99a0-2b1ec1f4bce5",
"requestParameters": {
"apiId": "j4sinjzb1c",
"outputType": "JSON",
"specification": "OAS30"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
FlushStageCache
#Description
Flushes a stage's cache.
GenerateClientCertificate
#Description
Generates a ClientCertificate resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDenied",
"errorMessage": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:POST on resource: arn:aws:apigateway:us-west-2::/clientcertificates",
"eventID": "7a817db4-af9a-4dfc-a988-53bebfdf555e",
"eventName": "GenerateClientCertificate",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-11-17T07:56:47Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "ef828b25-0149-417c-98a1-1dc3e18f12ba",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "8.103.248.255",
"userAgent": "aws-cli/1.14.44 Python/3.6.8 Linux/4.4.0-039049-Microsoft botocore/1.8.48",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetAccount
#Description
Gets information about the current Account resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "98e29799-b6f6-4082-b3cb-42c585144092",
"eventName": "GetAccount",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:17:18Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "69c9f926-f6e0-11e6-90bc-baceba3c05e0",
"requestParameters": {
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetApi
#Description
Gets an Api resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDeniedException",
"eventID": "b0d5408d-8bbb-4cc4-83e3-aecfe338bede",
"eventName": "GetApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-05-15T11:31:27Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "fa465abf-7704-11e9-8b1b-9cd40cf0d460",
"requestParameters": {
"apiId": "v"
},
"responseElements": {
"Message": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/apis/v"
},
"sourceIPAddress": "115.207.241.151",
"userAgent": "aws-cli/1.16.156 Python/3.7.3 Darwin/18.5.0 botocore/1.12.146",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetApiMapping
#Description
Gets an API mapping.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "75490ac6-96b7-4c41-ad55-d89c66da33c0",
"eventName": "GetApiMapping",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:39Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "0b29c44e-e61d-43c1-8825-84ae8cd3096d",
"requestParameters": {
"apiMappingId": "dw-probe",
"domainName": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetApiMappings
#Description
Gets API mappings.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDeniedException",
"eventID": "fb9a02d2-e8a8-4890-b3ef-d04aa89d273c",
"eventName": "GetApiMappings",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-04-19T16:31:17Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "8e84a046-62c0-11e9-80a2-77b9ea686721",
"requestParameters": {
"domainName": "flaws.cloud"
},
"responseElements": {
"Message": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/domainnames/flaws.cloud/apimappings"
},
"sourceIPAddress": "242.251.253.109",
"userAgent": "aws-cli/1.16.130 Python/2.7.15rc1 Linux/4.15.0-47-generic botocore/1.12.120",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetApis
#Description
Gets a collection of Api resources.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDeniedException",
"eventID": "d2b4e2a9-ce9d-40d3-8dc3-06e980c808c3",
"eventName": "GetApis",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-04-19T16:31:28Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "952b342e-62c0-11e9-a8ed-904c59ff3d05",
"requestParameters": null,
"responseElements": {
"Message": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/apis"
},
"sourceIPAddress": "215.104.255.48",
"userAgent": "aws-cli/1.16.130 Python/2.7.15rc1 Linux/4.15.0-47-generic botocore/1.12.120",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetBasePathMapping
#Description
Describe a BasePathMapping resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid domain name identifier specified",
"eventCategory": "Management",
"eventID": "fe62fece-c41e-4079-82ff-67cf333d55ae",
"eventName": "GetBasePathMapping",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "ce90c718-9f6a-4907-a2d4-eacf27df8c2c",
"requestParameters": {
"basePath": "dw-probe",
"domainName": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetBasePathMappings
#Description
Represents a collection of BasePathMapping resources.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDenied",
"errorMessage": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/domainnames/flaws.cloud/basepathmappings",
"eventID": "b4195c52-158c-4602-8e5d-a8aacc890a63",
"eventName": "GetBasePathMappings",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-09-20T06:50:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "a5deb2ad-0224-4957-b34f-08997577be15",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "37.54.28.252",
"userAgent": "aws-cli/1.16.242 Python/3.7.3rc1 Linux/4.19.0-kali4-amd64 botocore/1.12.232",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetClientCertificate
#Description
Gets information about the current ClientCertificate resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid client certificate id specified",
"eventCategory": "Management",
"eventID": "b5d7f14c-2cd3-4c60-bae1-894d44d1330c",
"eventName": "GetClientCertificate",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "155ccdc0-e983-418c-aa78-e5d8b2fc5a17",
"requestParameters": {
"clientCertificateId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetClientCertificates
#Description
Gets a collection of ClientCertificate resources.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "ba06b310-e7c6-4a98-ac3c-f8144b4cf03a",
"eventName": "GetClientCertificates",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:21:07Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "f21a0f10-f6e0-11e6-9820-77f78e073058b",
"requestParameters": {
"limit": 1000,
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetDeployment
#Description
Gets information about a Deployment resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "89655cd5-5d92-4fe0-9fd1-06f37f7a150c",
"eventName": "GetDeployment",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:42:12Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "e3eeb5ec-f6e3-11e6-8c58-ed8c770152b95",
"requestParameters": {
"deploymentId": "xa6a4v",
"embed": [
"apisummary"
],
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetDeployments
#Description
Gets information about a Deployments collection.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "4e293596-6116-4e2a-b15e-d108b0fabb5e",
"eventName": "GetDeployments",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:21:07Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "f2213b64-f6e0-11e6-94f1-729607c74f9aa",
"requestParameters": {
"limit": 1000,
"restApiId": "mu80it4vd6",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetDocumentationPart
#Description
Gets a documentation part.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Documentation part identifier specified",
"eventID": "9499d7e5-a18d-43a3-90ab-41c529aa930f",
"eventName": "GetDocumentationPart",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2020-04-22T09:41:38Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "9e3b6ba3-dfe1-4e0a-986e-a66ab8cf0a0f",
"requestParameters": {
"documentationPartId": "y8nk5v2z1h",
"restApiId": "s33ppypa75",
"template": false
},
"responseElements": null,
"sourceIPAddress": "8.253.0.47",
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/80.0.3987.163 Chrome/80.0.3987.163 Safari/537.36",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetDocumentationParts
#Description
Gets documentation parts.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "deee367e-5964-41bc-bb29-a7fa5230db1f",
"eventName": "GetDocumentationParts",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:17:42Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "77a332cc-f6e0-11e6-9820-77f78e073058b",
"requestParameters": {
"limit": 1000,
"restApiId": "mu80it4vd6",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetDocumentationVersion
#Description
Gets a documentation version.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Documentation version specified",
"eventCategory": "Management",
"eventID": "93fa7809-91de-4ac9-8e01-5f8425e5088a",
"eventName": "GetDocumentationVersion",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "78352fa2-97fe-4a1a-9c6b-368e6138c9ad",
"requestParameters": {
"documentationVersion": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetDocumentationVersions
#Description
Gets documentation versions.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "c6a3300b-0179-4fd2-8ee8-201c10dadcaa",
"eventName": "GetDocumentationVersions",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:21:07Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "f37889-f6e0-11e6-9820-77f78e073058b",
"requestParameters": {
"limit": 100,
"restApiId": "mu80it4vd6",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetDomainName
#Description
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDenied",
"errorMessage": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/domainnames/lol.com",
"eventID": "134689d48-7d8e-4b6f-8b88-ff92eafbfacc",
"eventName": "GetDomainName",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-04-19T15:28:39Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"recipientAccountId": "811596193553",
"requestID": "ceade1d7-62b7-11e9-99a2-8fe58ded8f98",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "88.2.27.8",
"userAgent": "aws-cli/1.16.140 Python/3.6.7 Linux/4.15.0-47-generic botocore/1.12.130",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetDomainNameAccessAssociations
#Description
Represents a collection on DomainNameAccessAssociations resources.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "c7636147-9f66-43e3-81b1-eb7d48e4639f",
"eventName": "GetDomainNameAccessAssociations",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:31:27Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "4864cf78-7394-40d8-974b-b40826bb7d6f",
"requestParameters": {
"resourceOwner": "SELF",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/D,Z,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetDomainNames
#Description
Represents a collection of DomainName resources.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "2230b982-628e-42da-84e2-46394b9a482",
"eventName": "GetDomainNames",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-27T00:01:11Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "d8d8c5fa-fc7f-11e6-a84c-745fb7c82b6b",
"requestParameters": {
"limit": 1000,
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAHNXISLUUAY64GZPM",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-26T17:48:22Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetExport
#Description
Exports a deployed version of a RestApi in a specified format.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "2785eadf-7a01-409e-a07f-f088c07e1d61",
"eventName": "GetExport",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2020-03-04T01:17:36Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "b42ef216-5a8b-49bb-a612-4eb076656e11c",
"requestParameters": {
"accepts": "application/json",
"exportType": "swagger",
"parameters": {
"extensions": "integrations"
},
"restApiId": "s33ppypa75",
"stageName": "Prod"
},
"responseElements": null,
"sourceIPAddress": "248.7.255.165",
"userAgent": "aws-cli/1.18.13 Python/3.7.4 Linux/4.14.165-131.185.amzn2.x86_64 botocore/1.15.13",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetGatewayResponse
#Description
Gets a GatewayResponse of a specified response type on the given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "0329ae17-e8b8-428a-b24e-c0eeb57ac9cd",
"eventName": "GetGatewayResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2018-01-11T23:19:33Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "e1dc2106-f725-11e7-9f73-3b442037f51ae",
"requestParameters": {
"responseType": "INVALID_SIGNATURE",
"restApiId": "s33ppypa75",
"template": false
},
"responseElements": null,
"sourceIPAddress": "208.228.3.168",
"userAgent": "aws-cli/1.11.190 Python/3.6.4 Darwin/16.3.0 botocore/1.7.48",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetGatewayResponses
#Description
Gets the GatewayResponses collection on the given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "415cd4bd-8df1-42c6-99fe-733afe0d5d37",
"eventName": "GetGatewayResponses",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2018-01-11T23:19:01Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "cebc8040-f725-11e7-9f73-3b442037f51ae",
"requestParameters": {
"restApiId": "s33ppypa75",
"template": false
},
"responseElements": null,
"sourceIPAddress": "208.228.3.168",
"userAgent": "aws-cli/1.11.190 Python/3.6.4 Darwin/16.3.0 botocore/1.7.48",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetIntegration
#Description
Get the integration settings.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "56a5ee8f-9daa-4c79-b672-3b514f301a29",
"eventName": "GetIntegration",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:34:17Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "c89ca6f1-f6e2-11e6-8af5-89e48d59137",
"requestParameters": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetIntegrationResponse
#Description
Represents a get integration response.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "9d00b613-3231-4409-93bd-a294a97162ea",
"eventName": "GetIntegrationResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-04-19T18:21:51Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "00cc01cf-62d0-11e9-80ad-feb37e9a1a93",
"requestParameters": {
"httpMethod": "GET",
"resourceId": "6m5gni",
"restApiId": "s33ppypa75",
"statusCode": "200",
"template": false
},
"responseElements": null,
"sourceIPAddress": "231.255.215.126",
"userAgent": "aws-cli/1.16.130 Python/2.7.15rc1 Linux/4.15.0-47-generic botocore/1.12.120",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetIntegrationResponses
#Description
Gets the IntegrationResponses for an Integration.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "f32c1d94-c846-4a49-a35d-395f42e6840d",
"eventName": "GetIntegrationResponses",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "3201b491-9f40-4a36-a58a-e834cebb0008",
"requestParameters": {
"apiId": "dw-probe",
"integrationId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetIntegrations
#Description
Gets the Integrations for an API.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDeniedException",
"eventID": "8788b7d6-2f93-4245-8208-b69999f99fc7",
"eventName": "GetIntegrations",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-05-15T12:57:10Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "f4098f39-7710-11e9-b96b-acde0e7a1d37",
"requestParameters": {
"apiId": "puspzvwgb6"
},
"responseElements": {
"Message": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/apis/puspzvwgb6/integrations"
},
"sourceIPAddress": "59.255.5.234",
"userAgent": "aws-cli/1.16.158 Python/3.6.6 Darwin/17.7.0 botocore/1.12.148",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetMethod
#Description
Describe an existing Method resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "5ed3bfa9-92e9-4785-9a50-5e8f504310",
"eventName": "GetMethod",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:54Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "13b11b6f-f6e0-11e6-b61a-4a33e1aa6d10",
"requestParameters": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetMethodResponse
#Description
Describes a MethodResponse resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "77a9c5a0-42de-4ecb-b3e4-6dfdd49faad2",
"eventName": "GetMethodResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-03-04T02:02:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "a5c80e3b-007e-11e7-9d8e-5cf1d6142a55",
"requestParameters": {
"httpMethod": "GET",
"resourceId": "6m5gni",
"restApiId": "s33ppypa75",
"statusCode": "200",
"template": false
},
"responseElements": null,
"sourceIPAddress": "220.4.119.96",
"userAgent": "aws-cli/1.11.56 Python/3.6.0 Darwin/16.4.0 botocore/1.5.19",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetModel
#Description
Describes an existing model defined for a RestApi resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "48ca21ca-11e0-442d-bc65-af5014a4c4c6",
"eventName": "GetModel",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:49:31Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "e9982fb6-f6e4-11e6-94f1-729607c74f9aa",
"requestParameters": {
"flatten": false,
"modelName": "Empty",
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetModels
#Description
Describes existing Models defined for a RestApi resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "d1e37aca-89ae-4220-a4e5-e4f91261cf4",
"eventName": "GetModels",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:42:05Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "dfa39ef4-f6e3-11e6-bb27-97de9e670e63",
"requestParameters": {
"limit": 1000,
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetModelTemplate
#Description
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "6cfbdf11-0c59-490d-ace8-fcd1e1c652fe",
"eventName": "GetModelTemplate",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-04-19T18:10:24Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "676ca921-62ce-11e9-93ef-2d67aa780886",
"requestParameters": {
"modelName": "Empty",
"restApiId": "s33ppypa75",
"template": false
},
"responseElements": null,
"sourceIPAddress": "231.255.215.126",
"userAgent": "aws-cli/1.16.130 Python/2.7.15rc1 Linux/4.15.0-47-generic botocore/1.12.120",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetPortal
#Description
Gets a portal.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "9cfa8d04-3e17-406c-a8c9-cd3575718a69",
"eventName": "GetPortal",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "12ee3a76-ba73-4cdc-a4ec-99e6cead9618",
"requestParameters": {
"portalId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetPortalProduct
#Description
Gets a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "4c4208f4-2e9e-4af1-803a-b66dd94e1de1",
"eventName": "GetPortalProduct",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "cee109a8-e0d6-478e-82a1-8567f16e7d59",
"requestParameters": {
"portalProductId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetPortalProductSharingPolicy
#Description
Gets the sharing policy for a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "3d388777-0b81-414d-bf2b-123a2713bb80",
"eventName": "GetPortalProductSharingPolicy",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "983584a5-cb96-406a-8030-13af4f99ba59",
"requestParameters": {
"portalProductId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetProductPage
#Description
Gets a product page of a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "cd9415b4-5e0a-4e26-99b1-bd895a40e2e6",
"eventName": "GetProductPage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "eebd2cbd-fe76-4ad6-af73-362190ddbb1b",
"requestParameters": {
"portalProductId": "dw-probe",
"productPageId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetProductRestEndpointPage
#Description
Gets a product REST endpoint page.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "ede64309-8c94-43f5-aa5e-382c6cde5a5d",
"eventName": "GetProductRestEndpointPage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "c748f512-9751-4e3d-8b50-59151229a944",
"requestParameters": {
"portalProductId": "dw-probe",
"productRestEndpointPageId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetRequestValidator
#Description
Gets a RequestValidator of a given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Request Validator identifier specified",
"eventCategory": "Management",
"eventID": "35e17ec6-7b8f-4231-8ff2-73a2a25653df",
"eventName": "GetRequestValidator",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "98e00189-2574-49e4-bb64-ecd40a7b4aa6",
"requestParameters": {
"requestValidatorId": "dw-probe",
"restApiId": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetRequestValidators
#Description
Gets the RequestValidators collection of a given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "b11ea837-dc7e-4c88-a66c-ad3ede73a5c1",
"eventName": "GetRequestValidators",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-08-03T22:44:22Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "4b23b807-789d-11e7-a0ef-66d2263124e6",
"requestParameters": {
"restApiId": "s33ppypa75",
"template": false
},
"responseElements": null,
"sourceIPAddress": "9.95.19.14",
"userAgent": "aws-cli/1.11.118 Python/2.7.10 Darwin/16.6.0 botocore/1.5.81",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetResource
#Description
Lists information about a resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "25ee794c-56a4-412b-86d0-4583e06e7cb9",
"eventName": "GetResource",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-03-07T19:38:21Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "9f92297-036d-11e7-9d8e-5cf1d6142a55",
"requestParameters": {
"resourceId": "6m5gni",
"restApiId": "s33ppypa75",
"template": false
},
"responseElements": null,
"sourceIPAddress": "253.5.152.254",
"userAgent": "aws-cli/1.9.20 Python/2.7.6 Linux/3.13.0-83-generic botocore/1.3.20",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetResources
#Description
Lists information about a collection of Resource resources.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "8bbd14cd-fcc2-492d-99b6-b6143c0c1a42",
"eventName": "GetResources",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:17:42Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "77a248b1-f6e0-11e6-b65f-9aab7e8e60d7",
"requestParameters": {
"embed": [
"methods"
],
"limit": 1000,
"restApiId": "mu80it4vd6",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetRestApi
#Description
Lists the RestApi resource in the collection.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "900f0631-c3f8-4b60-93bb-9a5fccd5affb",
"eventName": "GetRestApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:54Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "13b5133f-f6e0-11e6-8c58-ed8c770152b95",
"requestParameters": {
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetRestApis
#Description
Lists the RestApis resources for your collection.
Example CloudTrail Event #
{
"awsRegion": "sa-east-1",
"errorCode": "AccessDenied",
"errorMessage": "User: arn:aws:iam::731544447609:user/cloudsploit is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:sa-east-1::/restapis",
"eventCategory": "Management",
"eventID": "8e1b9e77-696c-4acc-8542-a24d3ec0a617",
"eventName": "GetRestApis",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2021-04-13T11:34:53Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "731544447609",
"requestID": "a5829c1e-65e0-42a4-bde1-79c1c1d7af69",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "34.12.134.20",
"userAgent": "aws-sdk-nodejs/2.885.0 linux/v14.16.1 callback",
"userIdentity": {
"accessKeyId": "AKIAYTOGP2RLGBSBSMH2",
"accountId": "731544447609",
"arn": "arn:aws:iam::731544447609:user/cloudsploit",
"principalId": "AIDAYTOGP2RLMDEPWZWMJ",
"type": "IAMUser",
"userName": "cloudsploit"
}
}
References #
GetRoute
#Description
Gets a Route.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "8dcdb348-c725-4a7c-90ce-3281bc250324",
"eventName": "GetRoute",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "bc8548dc-54da-4b90-b5aa-7783a7031e6f",
"requestParameters": {
"apiId": "dw-probe",
"routeId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetRouteResponse
#Description
Gets a RouteResponse.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "d85be646-e338-4a5d-a13b-6940184a6597",
"eventName": "GetRouteResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:40Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "497974c5-b4e8-4fbc-83b4-d093979b2ba3",
"requestParameters": {
"apiId": "dw-probe",
"routeId": "dw-probe",
"routeResponseId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetRouteResponses
#Description
Gets the RouteResponses for a Route.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "9a7a6ba8-de6b-4970-9080-13aeaf2c4dbf",
"eventName": "GetRouteResponses",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "e40e9dd4-2d51-47e9-ae5f-7955b69967f5",
"requestParameters": {
"apiId": "dw-probe",
"routeId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetRoutes
#Description
Gets the Routes for an API.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDeniedException",
"eventID": "f9c961eb-3968-44e6-9caa-1ce273502e81",
"eventName": "GetRoutes",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-04-19T15:32:35Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "5b945965-62b8-11e9-b9ed-d2ea8004cac0",
"requestParameters": {
"apiId": "%7B"
},
"responseElements": {
"Message": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/apis/%7B/routes"
},
"sourceIPAddress": "115.207.241.151",
"userAgent": "aws-cli/1.16.140 Python/3.6.7 Linux/4.15.0-47-generic botocore/1.12.130",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetRoutingRule
#Description
Gets a routing rule.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "da95e49b-bd6c-4be6-8a06-bdf9c1857c8c",
"eventName": "GetRoutingRule",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "c2ccefb5-3cae-45a0-9d7c-d97a1f9e2bc9",
"requestParameters": {
"domainName": "dw-probe",
"routingRuleId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetSdk
#Description
Generates a client SDK for a RestApi and Stage.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "5d535a93-2a3a-40e3-b3b9-094cab9a1c0b",
"eventName": "GetSdk",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-08-03T22:48:06Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "d084eb8a-789d-11e7-8bf8-0190e4b36dc0",
"requestParameters": {
"restApiId": "s33ppypa75",
"sdkType": "javascript",
"stageName": "Prod"
},
"responseElements": null,
"sourceIPAddress": "9.95.19.14",
"userAgent": "aws-cli/1.11.118 Python/2.7.10 Darwin/16.6.0 botocore/1.5.81",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetSdkType
#Description
Gets an SDK type.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "No SDK generator for 'dw-probe'",
"eventCategory": "Management",
"eventID": "8f7cfbc6-7bea-49be-acd3-2f2ec5146428",
"eventName": "GetSdkType",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "3a1ed195-d2db-4d8b-bb6d-6527c4afba34",
"requestParameters": {
"id": "dw-probe",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetSdkTypes
#Description
Gets SDK types
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "ef4c40a2-7578-4259-bcb1-9af997e7d4ea",
"eventName": "GetSdkTypes",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:21:07Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "f219c0ef-f6e0-11e6-9820-77f78e073058b",
"requestParameters": {
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetStage
#Description
Gets information about a Stage resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "62c001fb-c891-4290-b73d-1e8e6c65a6eb",
"eventName": "GetStage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-28T08:36:56Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "61684e74-fd91-11e6-aaf7-e3bae9bd7852",
"requestParameters": {
"restApiId": "s33ppypa75",
"stageName": "Prod",
"template": false
},
"responseElements": null,
"sourceIPAddress": "137.53.124.9",
"userAgent": "aws-cli/1.11.56 Python/2.7.10 Darwin/16.4.0 botocore/1.5.19",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetStages
#Description
Gets information about one or more Stage resources.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "e5923b37-65f0-4b19-bba0-d969cde43869",
"eventName": "GetStages",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2018-02-24T13:18:39Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "3a87a6fd-1965-11e8-a61b-770572064e41",
"requestParameters": {
"deploymentId": "8gppiv",
"restApiId": "s33ppypa75",
"template": false
},
"responseElements": null,
"sourceIPAddress": "245.181.7.4",
"userAgent": "aws-cli/1.9.1 Python/2.7.13 Darwin/17.3.0 botocore/1.4.72",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetUsage
#Description
Gets the usage data of a usage plan in a specified time interval.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid Usage Plan ID specified",
"eventCategory": "Management",
"eventID": "dba672f7-34cc-41fc-8d7a-55898962a7bf",
"eventName": "GetUsage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "970184a8-2990-442d-bc9c-99f670e885d4",
"requestParameters": {
"endDate": "dw-probe",
"startDate": "dw-probe",
"template": false,
"usagePlanId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetUsagePlan
#Description
Gets a usage plan of a given plan identifier.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "20a589a4-f07b-4a8a-b12d-061c70eeee54",
"eventName": "GetUsagePlan",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:45:51Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "917224b5b-f6e4-11e6-9820-77f78e073058b",
"requestParameters": {
"template": false,
"usagePlanId": "lqxj5e"
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetUsagePlanKey
#Description
Gets a usage plan key of a given key identifier.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"errorMessage": "Invalid API Key identifier specified",
"eventCategory": "Management",
"eventID": "d8be997b-aa64-4e87-929b-6c36354b8b68",
"eventName": "GetUsagePlanKey",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "cc6d2930-d36c-46cd-847e-b582f0ccf1c3",
"requestParameters": {
"keyId": "dw-probe",
"template": false,
"usagePlanId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
GetUsagePlanKeys
#Description
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "329f085c-dc86-4970-938f-be25ff246a5e",
"eventName": "GetUsagePlanKeys",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:45:51Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "66bede9e-f6e4-11e6-a8fd-45f7b8654c2c",
"requestParameters": {
"limit": 100,
"template": false,
"usagePlanId": "lqxj5e"
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetUsagePlans
#Description
Gets all the usage plans of the caller's account.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "9fdad294-1ac5-4849-b992-e4f1cbda4eeb",
"eventName": "GetUsagePlans",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:19:25Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "b569dd87-f6e0-11e6-b65f-9aab7e8e60d7",
"requestParameters": {
"keyId": "h0fh6siai6",
"limit": 1000,
"template": false
},
"responseElements": null,
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
GetVpcLink
#Description
Gets a specified VPC link under the caller's account in a region.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDenied",
"errorMessage": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:GET on resource: arn:aws:apigateway:us-west-2::/vpclinks/puspzvwgb6",
"eventID": "638f104e-7bd9-498e-8841-ca916ac75c56",
"eventName": "GetVpcLink",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-11-17T07:21:34Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "bec394ae-b763-43fd-80a5-b07f4fd0e32d",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "8.103.248.255",
"userAgent": "aws-cli/1.16.283 Python/3.6.0 Windows/10 botocore/1.13.19",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
GetVpcLinks
#Description
Gets the VpcLinks collection under the caller's account in a selected region.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "ddf917648-e233-4f6c-aa2d-28a376855032",
"eventName": "GetVpcLinks",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2019-02-27T01:29:24Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "811596193553",
"requestID": "1d6a7220-3a2f-11e9-8946-4125fa6a103b",
"requestParameters": {
"template": false
},
"responseElements": null,
"sourceIPAddress": "142.223.2.44",
"userAgent": "aws-cli/1.14.44 Python/3.6.6 Linux/4.9.93-boot2docker botocore/1.8.48",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
ImportApi
#Description
Imports an API.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "eb7d8703-39c3-43c1-9625-f470d3df9287",
"eventName": "ImportApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:21Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "7765bd5f-586b-4305-bc0f-86bc2214fcad",
"requestParameters": {
"body": {
"openapi": "3.0.0",
"info": {
"title": "dwfix-imported-http",
"version": "1.0"
},
"paths": {
"/ping": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"x-amazon-apigateway-integration": {
"type": "mock",
"payloadFormatVersion": "1.0"
}
}
}
}
},
"failOnWarnings": "false"
},
"responseElements": {
"apiEndpoint": "https://vve1b7kmrj.execute-api.us-west-1.amazonaws.com",
"apiId": "vve1b7kmrj",
"apiKeySelectionExpression": "$request.header.x-api-key",
"createdDate": "2026-06-29T20:59:20Z",
"disableExecuteApiEndpoint": false,
"ipAddressType": "ipv4",
"name": "dwfix-imported-http",
"protocolType": "HTTP",
"routeSelectionExpression": "$request.method $request.path",
"tags": {},
"version": "1.0",
"warnings": [
"Unable to create integration for resource at path 'GET /ping': Currently, an API with a protocol type of HTTP may only be associated with proxy integrations (AWS_PROXY, HTTP_PROXY). Ignoring."
]
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ImportApiKeys
#Description
Import API keys from an external source, such as a CSV-formatted file.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"errorCode": "AccessDenied",
"errorMessage": "User: arn:aws:iam::811596193553:user/Level6 is not authorized to perform: apigateway:POST on resource: arn:aws:apigateway:us-west-2::/apikeys",
"eventID": "64f80ca1-22e5-40fa-98c4-606833f1efc",
"eventName": "ImportApiKeys",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2018-05-29T20:32:02Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"recipientAccountId": "811596193553",
"requestID": "37383-637f-11e8-9874-4bf998f6ac71",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "253.253.218.192",
"userAgent": "aws-cli/1.15.21 Python/3.6.5 Linux/4.16.8-1-ARCH botocore/1.10.21",
"userIdentity": {
"accessKeyId": "AKIA3Z2XBVUDFQ9TU4MD",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:user/Level6",
"principalId": "AIDADO2GQD0K8TEF7KW1V",
"type": "IAMUser",
"userName": "Level6"
}
}
References #
ImportDocumentationParts
#Description
Imports documentation parts
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Unable to build importer with provided input.",
"eventCategory": "Management",
"eventID": "c79c4c88-5fe4-4add-ba67-f71a039f9175",
"eventName": "ImportDocumentationParts",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:15Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "2e186683-d1fc-4cc9-adae-c1874db6447a",
"requestParameters": {
"body": {
"address": 0,
"bigEndian": true,
"capacity": 85,
"hb": [
91,
123,
34,
108,
111,
99,
97,
116,
105,
111,
110,
34,
58,
32,
123,
34,
116,
121,
112,
101,
34,
58,
32,
34,
65,
80,
73,
34,
125,
44,
32,
34,
112,
114,
111,
112,
101,
114,
116,
105,
101,
115,
34,
58,
32,
34,
123,
92,
34,
100,
101,
115,
99,
114,
105,
112,
116,
105,
111,
110,
92,
34,
58,
32,
92,
34,
105,
109,
112,
111,
114,
116,
101,
100,
32,
100,
111,
99,
115,
92,
34,
125,
34,
125,
93
],
"isReadOnly": false,
"limit": 85,
"mark": -1,
"nativeByteOrder": false,
"offset": 0,
"position": 0
},
"failOnWarnings": false,
"restApiId": "3vn2gv80s2",
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ImportRestApi
#Description
A feature of the API Gateway control service for creating a new API from an external API definition file.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "c21668c1-4ade-491b-9b1c-ccfd4a083cca",
"eventName": "ImportRestApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:17Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "44a31e64-3329-43d3-85d7-1d8a6afdb379",
"requestParameters": {
"body": {
"swagger": "2.0",
"info": {
"title": "dwfix-imported-rest",
"version": "1.0"
},
"paths": {
"/ping": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"x-amazon-apigateway-integration": {
"type": "mock",
"requestTemplates": {
"application/json": {
"statusCode": 200
}
},
"responses": {
"default": {
"statusCode": "200"
}
}
}
}
}
}
},
"failOnWarnings": false,
"parameters": {
"failonwarnings": "false",
"mode": "import"
},
"template": false
},
"responseElements": {
"apiKeySource": "HEADER",
"apiStatus": "AVAILABLE",
"authorizerById": {
"restApiId": "hvlg87s90c",
"template": true
},
"authorizerCreate": {
"restApiId": "hvlg87s90c",
"template": false
},
"createdDate": "Jun 29, 2026 8:59:16 PM",
"deploymentById": {
"restApiId": "hvlg87s90c",
"template": true,
"templateSkipList": [
"position"
]
},
"deploymentCreate": {
"restApiId": "hvlg87s90c",
"template": false
},
"disableExecuteApiEndpoint": false,
"documentationpartById": {
"restApiId": "hvlg87s90c",
"template": true
},
"documentationpartCreate": {
"createDocumentationPartInput": {
"location": {
"method": "GET",
"path": "/ping",
"statusCode": "200",
"type": "RESPONSE"
},
"properties": {
"description": "OK"
}
},
"restApiId": "hvlg87s90c",
"template": false
},
"documentationpartImport": {
"failOnWarnings": false,
"restApiId": "hvlg87s90c",
"template": true
},
"documentationversionByVersion": {
"restApiId": "hvlg87s90c",
"template": true
},
"documentationversionCreate": {
"restApiId": "hvlg87s90c",
"template": false
},
"endpointConfiguration": {
"ipAddressType": "ipv4",
"types": [
"EDGE"
]
},
"gatewayresponseByType": {
"restApiId": "hvlg87s90c",
"template": true
},
"gatewayresponsePut": {
"restApiId": "hvlg87s90c",
"template": true
},
"id": "hvlg87s90c",
"modelByName": {
"flatten": false,
"restApiId": "hvlg87s90c",
"template": true
},
"modelCreate": {
"restApiId": "hvlg87s90c",
"template": false
},
"name": "dwfix-imported-rest",
"requestvalidatorById": {
"restApiId": "hvlg87s90c",
"template": true
},
"requestvalidatorCreate": {
"restApiId": "hvlg87s90c",
"template": false
},
"resourceById": {
"restApiId": "hvlg87s90c",
"template": true
},
"resourceCreate": {
"parentId": "t6l5f6p7y9",
"restApiId": "hvlg87s90c",
"template": false
},
"restapiAuthorizers": {
"restApiId": "hvlg87s90c",
"template": false
},
"restapiDelete": {
"restApiId": "hvlg87s90c",
"template": false
},
"restapiDeployments": {
"restApiId": "hvlg87s90c",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiDocumentationParts": {
"restApiId": "hvlg87s90c",
"template": false
},
"restapiDocumentationVersions": {
"restApiId": "hvlg87s90c",
"template": false
},
"restapiGatewayResponses": {
"restApiId": "hvlg87s90c",
"template": false
},
"restapiModels": {
"restApiId": "hvlg87s90c",
"template": false
},
"restapiRequestValidators": {
"restApiId": "hvlg87s90c",
"template": false
},
"restapiResources": {
"restApiId": "hvlg87s90c",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiStages": {
"restApiId": "hvlg87s90c",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiUpdate": {
"restApiId": "hvlg87s90c",
"template": false
},
"rootResourceId": "t6l5f6p7y9",
"securityPolicy": "TLS_1_0",
"self": {
"restApiId": "hvlg87s90c",
"template": false
},
"stageByName": {
"restApiId": "hvlg87s90c",
"template": true
},
"stageCreate": {
"restApiId": "hvlg87s90c",
"template": false
},
"version": "1.0"
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ListPortalProducts
#Description
Lists portal products.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "f9d8022f-bd71-4db1-9802-e95e7a8ef71f",
"eventName": "ListPortalProducts",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:31:27Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "716edb10-02c8-453b-b8ad-10699c605bda",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/D,Z,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ListPortals
#Description
Lists portals.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "ace39067-8280-42c4-96ef-d803edb62dc7",
"eventName": "ListPortals",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:31:27Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "9364ca5f-ee8b-47e9-a291-2fe297f15496",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/D,Z,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ListProductPages
#Description
Lists the product pages for a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "94a36329-7fd8-46d7-a890-5af868d57d24",
"eventName": "ListProductPages",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "e5dd5823-8c76-4d49-ac89-90c3d6cabcd8",
"requestParameters": {
"portalProductId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ListProductRestEndpointPages
#Description
Lists the product REST endpoint pages of a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "5f16cbb5-0995-459f-bf15-13dc852fd3ad",
"eventName": "ListProductRestEndpointPages",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "b9e9d5d2-4fbc-4c02-b40a-c3051644c743",
"requestParameters": {
"portalProductId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
ListRoutingRules
#Description
Lists routing rules.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "f82c4c35-85d7-419d-9cdc-ec47c443a001",
"eventName": "ListRoutingRules",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T18:42:41Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "e7814c7e-d9c8-4e54-a9e6-c7d345ababe3",
"requestParameters": {
"domainName": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
PreviewPortal
#Description
Creates a portal preview.
PublishPortal
#Description
Publishes a portal.
PutGatewayResponse
#Description
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "e726f122-10c9-4b75-a841-d6257e6e84fc",
"eventName": "PutGatewayResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:14Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "1037697d-9929-4232-9711-b195af927249",
"requestParameters": {
"putGatewayResponseInput": {
"responseTemplates": {
"application/json": {
"message": "$context.error.message"
}
}
},
"responseType": "DEFAULT_4XX",
"restApiId": "3vn2gv80s2",
"template": false
},
"responseElements": {
"defaultResponse": false,
"gatewayresponseDelete": {
"responseType": "DEFAULT_4XX",
"restApiId": "3vn2gv80s2",
"template": false
},
"gatewayresponsePut": {
"restApiId": "3vn2gv80s2",
"template": true
},
"gatewayresponseUpdate": {
"responseType": "DEFAULT_4XX",
"restApiId": "3vn2gv80s2",
"template": false
},
"responseParameters": {},
"responseTemplates": {
"application/json": {
"message": "$context.error.message"
}
},
"responseType": "DEFAULT_4XX",
"self": {
"responseType": "DEFAULT_4XX",
"restApiId": "3vn2gv80s2",
"template": false
}
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
PutIntegration
#Description
Sets up a method's integration.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "8f2489c5-47ae-4e58-838d-9f5e144603ea",
"eventName": "PutIntegration",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:53Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "984978c-f6e0-11e6-a8fd-45f7b8654c2c",
"requestParameters": {
"httpMethod": "ANY",
"putIntegrationInput": {
"httpMethod": "POST",
"type": "AWS_PROXY",
"uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:811596193553:function:level6-ec1335a148b902503664e2d162fcdaa98c224ea5/invocations"
},
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": {
"cacheKeyParameters": [],
"cacheNamespace": "cgwh6i",
"httpMethod": "POST",
"integrationDelete": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"integrationUpdate": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"integrationresponsePut": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": true
},
"passthroughBehavior": "WHEN_NO_MATCH",
"self": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"type": "AWS_PROXY",
"uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:811596193553:function:level6-ec1335a148b902503664e2d162fcdaa98c224ea5/invocations"
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
PutIntegrationResponse
#Description
Represents a put integration.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "ca76747-f9a2-45f2-a3f2-3973c05903",
"eventName": "PutIntegrationResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:53Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "1333fc58-f6e0-11e6-8c58-ed8c770152b95",
"requestParameters": {
"httpMethod": "ANY",
"putIntegrationResponseInput": {
"selectionPattern": ".*"
},
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false
},
"responseElements": {
"integrationresponseDelete": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false
},
"integrationresponseUpdate": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false
},
"selectionPattern": ".*",
"self": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false,
"title": "200"
},
"statusCode": "200"
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
PutMethod
#Description
Add a method to an existing Resource resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "d99de49f-590d-4d54-aa19-2dd687503f7e1",
"eventName": "PutMethod",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:53Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "131ea016-f6e0-11e6-bb27-97de9e670e63",
"requestParameters": {
"httpMethod": "ANY",
"putMethodInput": {
"apiKeyRequired": false,
"authorizationType": "NONE"
},
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"responseElements": {
"apiKeyRequired": false,
"authorizationType": "NONE",
"httpMethod": "ANY",
"integrationPut": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"methodDelete": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"methodUpdate": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false
},
"methodresponsePut": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": true
},
"self": {
"httpMethod": "ANY",
"name": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"template": false,
"title": "ANY"
}
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
PutMethodResponse
#Description
Adds a MethodResponse to an existing Method resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "fc45774-fa23-4727-af3a-479f303bf1fd",
"eventName": "PutMethodResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T20:14:53Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "132ef318-f6e0-11e6-b61a-4a33e1aa6d10",
"requestParameters": {
"httpMethod": "ANY",
"putMethodResponseInput": {
"responseModels": {}
},
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false
},
"responseElements": {
"methodresponseDelete": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false
},
"methodresponseUpdate": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false
},
"responseModels": {},
"self": {
"httpMethod": "ANY",
"resourceId": "cgwh6i",
"restApiId": "oqqw7yl1k8",
"statusCode": "200",
"template": false,
"title": "200"
},
"statusCode": "200"
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "console.amazonaws.com",
"userIdentity": {
"accessKeyId": "ASIA1HCU56S459ZRFL3M",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
PutPortalProductSharingPolicy
#Description
Updates the sharing policy for a portal product.
PutRestApi
#Description
A feature of the API Gateway control service for updating an existing API with an input of external API definitions.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "5d8e7b4a-7c4f-4a72-a028-cf651e803634",
"eventName": "PutRestApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:15Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "3019d2fe-bf53-4a4d-b0ab-5f8cb313cdcf",
"requestParameters": {
"body": {
"swagger": "2.0",
"info": {
"title": "dwfix merged",
"version": "1.0"
},
"paths": {}
},
"failOnWarnings": false,
"mode": "merge",
"parameters": {
"failonwarnings": "false",
"mode": "merge"
},
"restApiId": "3vn2gv80s2",
"template": false
},
"responseElements": {
"apiKeySource": "HEADER",
"apiStatus": "AVAILABLE",
"authorizerById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"authorizerCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"createdDate": "Jun 29, 2026 8:59:13 PM",
"deploymentById": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"deploymentCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"disableExecuteApiEndpoint": false,
"documentationpartById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"documentationpartCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"documentationpartImport": {
"failOnWarnings": false,
"restApiId": "3vn2gv80s2",
"template": true
},
"documentationversionByVersion": {
"restApiId": "3vn2gv80s2",
"template": true
},
"documentationversionCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"endpointConfiguration": {
"ipAddressType": "ipv4",
"types": [
"EDGE"
]
},
"gatewayresponseByType": {
"restApiId": "3vn2gv80s2",
"template": true
},
"gatewayresponsePut": {
"restApiId": "3vn2gv80s2",
"template": true
},
"id": "3vn2gv80s2",
"modelByName": {
"flatten": false,
"restApiId": "3vn2gv80s2",
"template": true
},
"modelCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"name": "dwfix merged",
"requestvalidatorById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"requestvalidatorCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"resourceById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"resourceCreate": {
"parentId": "c352s8aadk",
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiAuthorizers": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiDelete": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiDeployments": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiDocumentationParts": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiDocumentationVersions": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiGatewayResponses": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiModels": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiRequestValidators": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiResources": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiStages": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiUpdate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"rootResourceId": "c352s8aadk",
"securityPolicy": "TLS_1_0",
"self": {
"restApiId": "3vn2gv80s2",
"template": false
},
"stageByName": {
"restApiId": "3vn2gv80s2",
"template": true
},
"stageCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"tags": {
"env": "sample",
"project": "dwfix"
},
"version": "1.0"
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
PutRoutingRule
#Description
Updates a routing rule.
ReimportApi
#Description
Puts an Api resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "84ee291e-8192-422f-8400-678d178f539a",
"eventName": "ReimportApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:19Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "aaf6d185-51c0-4286-9e67-f44496e4c6e7",
"requestParameters": {
"apiId": "j4sinjzb1c",
"body": {
"openapi": "3.0.0",
"info": {
"title": "dwfix-reimported",
"version": "2.0"
},
"paths": {
"/dwfix": {
"get": {
"responses": {
"200": {
"description": "OK"
}
},
"x-amazon-apigateway-integration": {
"type": "mock",
"payloadFormatVersion": "1.0"
}
}
}
}
},
"failOnWarnings": "false"
},
"responseElements": {
"apiEndpoint": "https://j4sinjzb1c.execute-api.us-west-1.amazonaws.com",
"apiId": "j4sinjzb1c",
"apiKeySelectionExpression": "$request.header.x-api-key",
"createdDate": "2026-06-29T20:59:17Z",
"description": "dwfix HTTP API updated",
"disableExecuteApiEndpoint": false,
"ipAddressType": "ipv4",
"name": "dwfix-reimported",
"protocolType": "HTTP",
"routeSelectionExpression": "$request.method $request.path",
"tags": {},
"version": "2.0",
"warnings": [
"Unable to create integration for resource at path 'GET /dwfix': Currently, an API with a protocol type of HTTP may only be associated with proxy integrations (AWS_PROXY, HTTP_PROXY). Ignoring."
]
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
RejectDomainNameAccessAssociation
#Description
Rejects a domain name access association with a private custom domain name.
TagResource
#Description
Adds or updates a tag on a given resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "3fd46608-7e8f-479f-bfe9-6ae682b1ed3e",
"eventName": "TagResource",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:00:56Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "aa24c0c3-85fa-4a9e-b04e-2404cb688e2e",
"requestParameters": {
"resourceArn": "arn:aws:apigateway:us-west-1::/restapis/h4kjgdo8oh",
"tagResourceInput": {
"tags": {
"dw": "f"
}
},
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/b,D,Z cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
TestInvokeMethod
#Description
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
UntagResource
#Description
Removes a tag from a given resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid ARN specified in the request",
"eventCategory": "Management",
"eventID": "37a34a19-9144-4466-821e-1d982a2d1e84",
"eventName": "UntagResource",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "5878770a-e118-4f63-9c2a-8b5a20200bfe",
"requestParameters": {
"resourceArn": "dw-probe",
"tagKeys": [
"dw-probe"
],
"template": false
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateAccount
#Description
Changes information about the current Account resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "3129daed-faa9-4ec9-adbb-d47c862a5cf8",
"eventName": "UpdateAccount",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:16Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "709ca2ca-f7d2-40d5-93cc-69588b69ce9a",
"requestParameters": {
"template": false,
"updateAccountInput": {
"patchOperations": []
}
},
"responseElements": {
"accountUpdate": {
"template": false
},
"apiKeyVersion": "4",
"features": [
"UsagePlans"
],
"self": {
"template": false
},
"throttleSettings": {
"burstLimit": 5000,
"rateLimit": 10000.0
}
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateApi
#Description
Updates an Api resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "7239e89f-a820-48a0-87d2-4187ba1c5720",
"eventName": "UpdateApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "49a5dd2e-e31a-4490-8c34-29e40f770639",
"requestParameters": {
"apiId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateApiKey
#Description
Changes information about an ApiKey resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "0078ebd0-f86a-480c-a821-fb267638a655",
"eventName": "UpdateApiKey",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "92e727e1-5a3e-49eb-b59e-eae2797abeff",
"requestParameters": null,
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateApiMapping
#Description
The API mapping.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "06a1c890-91bb-402b-844f-ec3e5b3e1ca6",
"eventName": "UpdateApiMapping",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "eae67a87-ef8a-4ace-a0fd-4e2689274391",
"requestParameters": {
"apiId": "dw-probe",
"apiMappingId": "dw-probe",
"domainName": "dw-probe"
},
"responseElements": {
"message": "Invalid domain name identifier specified"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateBasePathMapping
#Description
Changes information about the BasePathMapping resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "a2093093-367b-4a74-b0fd-38697dc403b6",
"eventName": "UpdateBasePathMapping",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "5bafecf2-3452-4e4e-902e-7d9111b150c1",
"requestParameters": {
"basePath": "dw-probe",
"domainName": "dw-probe",
"template": false,
"updateBasePathMappingInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateClientCertificate
#Description
Changes information about an ClientCertificate resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "98e60e5f-f165-453f-b0f3-1aa82bd7ea27",
"eventName": "UpdateClientCertificate",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "801db4ef-6b0c-417f-908c-2fa4fe5500a6",
"requestParameters": {
"clientCertificateId": "dw-probe",
"template": false,
"updateClientCertificateInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateDeployment
#Description
Changes information about a Deployment resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "3a46e1a1-2550-4169-a45a-615c5aac04a1",
"eventName": "UpdateDeployment",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "9bd0da98-a272-476c-894b-fcd7d8b88f18",
"requestParameters": {
"deploymentId": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateDeploymentInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateDocumentationPart
#Description
Updates a documentation part.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "785d03fd-af36-4137-8a7c-066af207fbc9",
"eventName": "UpdateDocumentationPart",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "a60564b2-ba3a-4323-983b-14ab7661bdf4",
"requestParameters": {
"documentationPartId": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateDocumentationPartInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateDocumentationVersion
#Description
Updates a documentation version.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "4619c9fe-a467-4b4a-b7ec-b4398fe42296",
"eventName": "UpdateDocumentationVersion",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "4f57d06f-47ee-4f78-8262-c7cb89a9f272",
"requestParameters": {
"documentationVersion": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateDocumentationVersionInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateDomainName
#Description
Changes information about the DomainName resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "48391699-f231-4b46-9aaa-d7cad74c4c0b",
"eventName": "UpdateDomainName",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "be8a157f-6bc1-418e-94e0-164f183a0df5",
"requestParameters": {
"domainName": "dw-probe",
"template": false,
"updateDomainNameInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateGatewayResponse
#Description
Updates a GatewayResponse of a specified response type on the given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "d516af63-cce9-467e-b6bb-4c27f82cbca0",
"eventName": "UpdateGatewayResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "927269a8-d45f-4671-bed6-722d05094343",
"requestParameters": {
"responseType": "DEFAULT_4XX",
"restApiId": "dw-probe",
"template": false,
"updateGatewayResponseInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateIntegration
#Description
Represents an update integration.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "ae86bd08-5bcd-4bcc-974a-7714a4d306b1",
"eventName": "UpdateIntegration",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "47730cb8-e2cc-4ac4-92de-ee8e201eda77",
"requestParameters": {
"httpMethod": "dw-probe",
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateIntegrationInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateIntegrationResponse
#Description
Represents an update integration response.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "ValidationException",
"errorMessage": "1 validation error detected: Value 'dw-probe' at 'statusCode' failed to satisfy constraint: Member must satisfy regular expression pattern: [1-5]\\d\\d",
"eventCategory": "Management",
"eventID": "8c93f250-019e-4ebe-b5ba-fd07f8b5882c",
"eventName": "UpdateIntegrationResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "26f3356a-0436-4b99-9f2f-5272d0be3724",
"requestParameters": {
"httpMethod": "dw-probe",
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"statusCode": "dw-probe",
"template": false,
"updateIntegrationResponseInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateMethod
#Description
Updates an existing Method resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "98e36a70-6731-48d8-8e4f-d12642e5a39e",
"eventName": "UpdateMethod",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "06e7b694-ddce-4bd6-bbcc-f355255d96db",
"requestParameters": {
"httpMethod": "dw-probe",
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateMethodInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateMethodResponse
#Description
Updates an existing MethodResponse resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "ValidationException",
"errorMessage": "1 validation error detected: Value 'dw-probe' at 'statusCode' failed to satisfy constraint: Member must satisfy regular expression pattern: [1-5]\\d\\d",
"eventCategory": "Management",
"eventID": "ed6f5b6e-1339-4bea-90a1-9cd941db689a",
"eventName": "UpdateMethodResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "996d79f1-7d2b-425a-9924-f40ee9ca38e9",
"requestParameters": {
"httpMethod": "dw-probe",
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"statusCode": "dw-probe",
"template": false,
"updateMethodResponseInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateModel
#Description
Changes information about a model.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "dcd369e2-ad55-4a45-95b7-ae6fd1b235fb",
"eventName": "UpdateModel",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "b006ca0d-cee8-4d84-987c-a00bb1d64649",
"requestParameters": {
"modelName": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateModelInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdatePortal
#Description
Updates a portal.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "bdc66c90-537d-4a23-a2a5-d91838fb8d55",
"eventName": "UpdatePortal",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "59a219e6-21b5-43a5-be20-9303e1b2e51a",
"requestParameters": {
"portalId": "dw-probe"
},
"responseElements": {
"message": "2 validation errors detected: Value 'dw-probe' at 'portalId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdatePortalProduct
#Description
Updates the portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "e851272a-bf1b-4859-b2fa-537ef0f48f7b",
"eventName": "UpdatePortalProduct",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "d50b0777-d3fe-4b5c-9111-1a52b932e50b",
"requestParameters": {
"portalProductId": "dw-probe"
},
"responseElements": {
"message": "2 validation errors detected: Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateProductPage
#Description
Updates a product page of a portal product.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "d5e84a24-0998-4cc3-9e93-d3400a9a784a",
"eventName": "UpdateProductPage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "ea6f5ec6-5104-4f73-ab2a-c957efcfae5d",
"requestParameters": {
"portalProductId": "dw-probe",
"productPageId": "dw-probe"
},
"responseElements": {
"message": "4 validation errors detected: Value 'dw-probe' at 'productPageId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'productPageId' failed to satisfy constraint: Member must have length greater than or equal to 10; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateProductRestEndpointPage
#Description
Updates a product REST endpoint page.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"eventCategory": "Management",
"eventID": "f4a25d1e-1874-4d6b-bc9a-e3f30b2e6f51",
"eventName": "UpdateProductRestEndpointPage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:49Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "ad4a4950-2188-4736-b266-28795dac0b48",
"requestParameters": {
"portalProductId": "dw-probe",
"productRestEndpointPageId": "dw-probe"
},
"responseElements": {
"message": "4 validation errors detected: Value 'dw-probe' at 'productRestEndpointPageId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'productRestEndpointPageId' failed to satisfy constraint: Member must have length greater than or equal to 10; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must satisfy regular expression pattern: [a-z0-9]+; Value 'dw-probe' at 'portalProductId' failed to satisfy constraint: Member must have length greater than or equal to 10"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateRequestValidator
#Description
Updates a RequestValidator of a given RestApi.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "45b7fb53-55b1-4850-aaa8-f3713fb51519",
"eventName": "UpdateRequestValidator",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:50Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "2f5f85b6-80d1-4db0-a97a-183e05c6d15e",
"requestParameters": {
"requestValidatorId": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateRequestValidatorInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateResource
#Description
Changes information about a Resource resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "4d428d0c-78c5-4528-a2de-6dc197a2593e",
"eventName": "UpdateResource",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:50Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "5ae779de-d1b7-4d19-944b-2001721b862a",
"requestParameters": {
"resourceId": "dw-probe",
"restApiId": "dw-probe",
"template": false,
"updateResourceInput": {}
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateRestApi
#Description
Changes information about the specified API.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"eventCategory": "Management",
"eventID": "e7addf41-d4b0-4835-97ad-4814766f123b",
"eventName": "UpdateRestApi",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T20:59:15Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "71c6bb23-6c36-41e0-8097-cef504d44093",
"requestParameters": {
"restApiId": "3vn2gv80s2",
"template": false,
"updateRestApiInput": {
"patchOperations": [
{
"op": "replace",
"path": "/description",
"value": "dwfix updated"
}
]
}
},
"responseElements": {
"apiKeySource": "HEADER",
"apiStatus": "AVAILABLE",
"authorizerById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"authorizerCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"createdDate": "Jun 29, 2026 8:59:13 PM",
"deploymentById": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"deploymentCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"description": "dwfix updated",
"disableExecuteApiEndpoint": false,
"documentationpartById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"documentationpartCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"documentationpartImport": {
"failOnWarnings": false,
"restApiId": "3vn2gv80s2",
"template": true
},
"documentationversionByVersion": {
"restApiId": "3vn2gv80s2",
"template": true
},
"documentationversionCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"endpointConfiguration": {
"ipAddressType": "ipv4",
"types": [
"EDGE"
]
},
"gatewayresponseByType": {
"restApiId": "3vn2gv80s2",
"template": true
},
"gatewayresponsePut": {
"restApiId": "3vn2gv80s2",
"template": true
},
"id": "3vn2gv80s2",
"modelByName": {
"flatten": false,
"restApiId": "3vn2gv80s2",
"template": true
},
"modelCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"name": "dwfix-rest-api",
"requestvalidatorById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"requestvalidatorCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"resourceById": {
"restApiId": "3vn2gv80s2",
"template": true
},
"resourceCreate": {
"parentId": "c352s8aadk",
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiAuthorizers": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiDelete": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiDeployments": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiDocumentationParts": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiDocumentationVersions": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiGatewayResponses": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiModels": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiRequestValidators": {
"restApiId": "3vn2gv80s2",
"template": false
},
"restapiResources": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiStages": {
"restApiId": "3vn2gv80s2",
"template": true,
"templateSkipList": [
"position"
]
},
"restapiUpdate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"rootResourceId": "c352s8aadk",
"securityPolicy": "TLS_1_0",
"self": {
"restApiId": "3vn2gv80s2",
"template": false
},
"stageByName": {
"restApiId": "3vn2gv80s2",
"template": true
},
"stageCreate": {
"restApiId": "3vn2gv80s2",
"template": false
},
"tags": {}
},
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,n,b,D cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateRoute
#Description
Updates a Route.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "7ecafcb7-64d5-4ee6-9647-3793f93ed786",
"eventName": "UpdateRoute",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:50Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "4835e73e-9ca0-43c5-a389-99bcd25addb3",
"requestParameters": {
"apiId": "dw-probe",
"routeId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateRouteResponse
#Description
Updates a RouteResponse.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "NotFoundException",
"eventCategory": "Management",
"eventID": "d9975694-1a98-40b1-9f1a-06282b45e035",
"eventName": "UpdateRouteResponse",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:50Z",
"eventType": "AwsApiCall",
"eventVersion": "1.11",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "ea21028b-e9a0-4a9b-ac97-36653b5cd1c1",
"requestParameters": {
"apiId": "dw-probe",
"routeId": "dw-probe",
"routeResponseId": "dw-probe"
},
"responseElements": {
"message": "Invalid API identifier specified 123456789012:dw-probe"
},
"sourceIPAddress": "203.0.113.5",
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateStage
#Description
Changes information about a Stage resource.
Example CloudTrail Event #
{
"awsRegion": "us-west-2",
"eventID": "058bf730-1009-440d-8b3d-161f6ed7b9ad",
"eventName": "UpdateStage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2017-02-19T21:02:34Z",
"eventType": "AwsApiCall",
"eventVersion": "1.04",
"readOnly": false,
"recipientAccountId": "811596193553",
"requestID": "bc33eff1-f6e6-11e6-9820-77f78e073058b",
"requestParameters": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false,
"updateStageInput": {
"patchOperations": [
{
"op": "replace",
"path": "/deploymentId",
"value": "moil8t"
}
]
}
},
"responseElements": {
"cacheClusterEnabled": false,
"cacheClusterStatus": "NOT_AVAILABLE",
"createdDate": "Feb 19, 2017 9:01:33 PM",
"deploymentId": "moil8t",
"lastUpdatedDate": "Feb 19, 2017 9:02:34 PM",
"methodSettings": {},
"self": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
},
"stageDelete": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
},
"stageFlushAuthorizerCache": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
},
"stageName": "Level5",
"stageUpdate": {
"restApiId": "pvlftmiyea",
"stageName": "Level5",
"template": false
}
},
"sourceIPAddress": "255.253.125.115",
"userAgent": "Apache-HttpClient/4.5.x (Java/1.8.0_102)",
"userIdentity": {
"accessKeyId": "ASIAJGMT0U1DL7V6R08E",
"accountId": "811596193553",
"arn": "arn:aws:iam::811596193553:root",
"principalId": "811596193553",
"sessionContext": {
"attributes": {
"creationDate": "2017-02-19T15:37:15Z",
"mfaAuthenticated": "true"
}
},
"type": "Root"
}
}
References #
UpdateUsage
#Description
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "1288ebe5-0d5f-494d-9a82-20ccf25321f7",
"eventName": "UpdateUsage",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:50Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "5b115d34-1afc-4ea3-a9e6-b44274bfb0a3",
"requestParameters": {
"keyId": "dw-probe",
"template": false,
"updateUsageInput": {},
"usagePlanId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateUsagePlan
#Description
Updates a usage plan of a given plan Id.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "ed135fec-973c-4d4e-863e-30b3a05a1293",
"eventName": "UpdateUsagePlan",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:50Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "64235d65-4789-4d2b-a29a-ee49db2eae26",
"requestParameters": {
"template": false,
"updateUsagePlanInput": {},
"usagePlanId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}
UpdateVpcLink
#Description
Updates an existing VpcLink of a specified identifier.
Example CloudTrail Event #
{
"awsRegion": "us-west-1",
"errorCode": "BadRequestException",
"errorMessage": "Invalid request input",
"eventCategory": "Management",
"eventID": "25f91943-91f0-4327-aad0-fed5f156b97b",
"eventName": "UpdateVpcLink",
"eventSource": "apigateway.amazonaws.com",
"eventTime": "2026-06-29T19:21:50Z",
"eventType": "AwsApiCall",
"eventVersion": "1.08",
"managementEvent": true,
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "03e6d62e-2f66-498d-920c-4b1cfa5e4cb0",
"requestParameters": {
"template": false,
"updateVpcLinkInput": {},
"vpcLinkId": "dw-probe"
},
"responseElements": null,
"sourceIPAddress": "203.0.113.5",
"tlsDetails": {
"cipherSuite": "TLS_AES_128_GCM_SHA256",
"clientProvidedHostHeader": "apigateway.us-west-1.amazonaws.com",
"tlsVersion": "TLSv1.3"
},
"userAgent": "Boto3/1.43.36 md/Botocore#1.43.36 ua/2.1 os/linux#6.1.0-41-amd64 md/arch#x86_64 lang/python#3.11.2 md/pyimpl#CPython m/Z,D,b cfg/retry-mode#legacy Botocore/1.43.36",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/sample-user",
"principalId": "AIDAEXAMPLE00000000",
"type": "IAMUser",
"userName": "sample-user"
}
}