Specifies the target API entity to which the documentation applies.
Contents
- type
-
The type of API entity to which the documentation content applies. Valid values are
API,AUTHORIZER,MODEL,RESOURCE,METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. Content inheritance does not apply to any entity of theAPI,AUTHORIZER,METHOD,MODEL,REQUEST_BODY, orRESOURCEtype.Type: String
Valid Values:
API | AUTHORIZER | MODEL | RESOURCE | METHOD | PATH_PARAMETER | QUERY_PARAMETER | REQUEST_HEADER | REQUEST_BODY | RESPONSE | RESPONSE_HEADER | RESPONSE_BODYRequired: Yes
- method
-
The HTTP verb of a method. It is a valid field for the API entity types of
METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. The default value is*for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocationattributes, the child entity'smethodattribute must match that of the parent entity exactly.Type: String
Required: No
- name
-
The name of the targeted API entity. It is a valid and required field for the API entity types of
AUTHORIZER,MODEL,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODYandRESPONSE_HEADER. It is an invalid field for any other entity type.Type: String
Required: No
- path
-
The URL path of the target. It is a valid field for the API entity types of
RESOURCE,METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. The default value is/for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the otherlocationattributes, the child entity'spathattribute must match that of the parent entity as a prefix.Type: String
Required: No
- statusCode
-
The HTTP status code of a response. It is a valid field for the API entity types of
RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. The default value is*for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocationattributes, the child entity'sstatusCodeattribute must match that of the parent entity exactly.Type: String
Pattern:
^([1-5]\d\d|\*|\s*)$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
