DocumentationPartLocation Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    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, and RESPONSE_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 other location attributes, the child entity’s method attribute must match that of the parent entity exactly.

Declaration

Swift

public let method: String?


                    
                    
                    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_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.

Declaration

Swift

public let name: String?


                    
                    
                    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, and RESPONSE_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 other location attributes, the child entity’s path attribute must match that of the parent entity as a prefix.

Declaration

Swift

public let path: String?


                    
                    
                    statusCode

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_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 other location attributes, the child entity’s statusCode attribute must match that of the parent entity exactly.

Declaration

Swift

public let statusCode: String?


                    
                    
                    type

[Required] 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, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.

Declaration

Swift

public let type: DocumentationPartType


                    
                    
                    init(method:name:path:statusCode:type:)

Undocumented

Declaration

Swift

public init(method: String? = nil, name: String? = nil, path: String? = nil, statusCode: String? = nil, type: DocumentationPartType)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws