apigateway_get_method: Describe an existing Method resource

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Describe an existing Method resource.

Usage

1
apigateway_get_method(restApiId, resourceId, httpMethod)

Arguments

restApiId

[required] [Required] The string identifier of the associated RestApi.

resourceId

[required] [Required] The Resource identifier for the Method resource.

httpMethod

[required] [Required] Specifies the method request's HTTP method type.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
list(
  httpMethod = "string",
  authorizationType = "string",
  authorizerId = "string",
  apiKeyRequired = TRUE|FALSE,
  requestValidatorId = "string",
  operationName = "string",
  requestParameters = list(
    TRUE|FALSE
  ),
  requestModels = list(
    "string"
  ),
  methodResponses = list(
    list(
      statusCode = "string",
      responseParameters = list(
        TRUE|FALSE
      ),
      responseModels = list(
        "string"
      )
    )
  ),
  methodIntegration = list(
    type = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY",
    httpMethod = "string",
    uri = "string",
    connectionType = "INTERNET"|"VPC_LINK",
    connectionId = "string",
    credentials = "string",
    requestParameters = list(
      "string"
    ),
    requestTemplates = list(
      "string"
    ),
    passthroughBehavior = "string",
    contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
    timeoutInMillis = 123,
    cacheNamespace = "string",
    cacheKeyParameters = list(
      "string"
    ),
    integrationResponses = list(
      list(
        statusCode = "string",
        selectionPattern = "string",
        responseParameters = list(
          "string"
        ),
        responseTemplates = list(
          "string"
        ),
        contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"
      )
    ),
    tlsConfig = list(
      insecureSkipVerification = TRUE|FALSE
    )
  ),
  authorizationScopes = list(
    "string"
  )
)

Request syntax

1
2
3
4
5
svc$get_method(
  restApiId = "string",
  resourceId = "string",
  httpMethod = "string"
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.