models.execute-api-2018-11-29-intermediate.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigatewaymanagementapi Show documentation
Show all versions of apigatewaymanagementapi Show documentation
The AWS Java SDK for ApiGatewayManagementApi module holds the client classes that are used for
communicating with ApiGatewayManagementApi.
{
"customizationConfig" : {
"attachPayloadTraitToMember" : { },
"blacklistedSimpleMethods" : [ ],
"calculateCrc32FromCompressedData" : false,
"convenienceTypeOverloads" : [ ],
"customErrorCodeFieldName" : null,
"customProtocolFactoryFqcn" : null,
"customResponseMetadata" : null,
"customRetryPolicy" : null,
"customServiceMetadata" : null,
"defaultSimpleMethodTestRegion" : null,
"deprecatedOperations" : [ ],
"deprecatedShapes" : [ ],
"excludeClientCreateMethod" : false,
"modelMarshallerDefaultValueSupplier" : { },
"operationModifiers" : null,
"paginationCustomization" : null,
"renameShapes" : null,
"sdkModeledExceptionBaseClassName" : null,
"sdkRequestBaseClassName" : null,
"sdkResponseBaseClassName" : null,
"serviceSpecificClientConfigClass" : null,
"serviceSpecificHttpConfig" : null,
"shapeModifiers" : null,
"shapeSubstitutions" : null,
"shareModelConfig" : null,
"skipSyncClientGeneration" : false,
"useAutoConstructList" : true,
"useAutoConstructMap" : true,
"verifiedSimpleMethods" : [ ]
},
"metadata" : {
"apiVersion" : "2018-11-29",
"asyncBuilder" : "DefaultApiGatewayManagementApiAsyncClientBuilder",
"asyncBuilderInterface" : "ApiGatewayManagementApiAsyncClientBuilder",
"asyncClient" : "DefaultApiGatewayManagementApiAsyncClient",
"asyncInterface" : "ApiGatewayManagementApiAsyncClient",
"authPolicyPackageName" : null,
"authType" : "V4",
"baseBuilder" : "DefaultApiGatewayManagementApiBaseClientBuilder",
"baseBuilderInterface" : "ApiGatewayManagementApiBaseClientBuilder",
"baseExceptionName" : "ApiGatewayManagementApiException",
"baseRequestName" : "ApiGatewayManagementApiRequest",
"baseResponseName" : "ApiGatewayManagementApiResponse",
"cborProtocol" : false,
"clientPackageName" : "apigatewaymanagementapi",
"contentType" : null,
"defaultEndpoint" : null,
"defaultEndpointWithoutHttpProtocol" : null,
"defaultRegion" : null,
"descriptiveServiceName" : "AmazonApiGatewayManagementApi",
"documentation" : "The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.
",
"endpointPrefix" : "execute-api",
"fullAuthPolicyPackageName" : "software.amazon.awssdk.services",
"fullClientPackageName" : "software.amazon.awssdk.services.apigatewaymanagementapi",
"fullModelPackageName" : "software.amazon.awssdk.services.apigatewaymanagementapi.model",
"fullPaginatorsPackageName" : "software.amazon.awssdk.services.apigatewaymanagementapi.paginators",
"fullRequestTransformPackageName" : "software.amazon.awssdk.services.apigatewaymanagementapi.transform",
"fullTransformPackageName" : "software.amazon.awssdk.services.apigatewaymanagementapi.transform",
"ionProtocol" : false,
"jsonProtocol" : true,
"jsonVersion" : "1.1",
"modelPackageName" : "apigatewaymanagementapi.model",
"paginatorsPackageName" : "apigatewaymanagementapi.paginators",
"protocol" : "rest-json",
"requestTransformPackageName" : "apigatewaymanagementapi.transform",
"requiresApiKey" : false,
"requiresIamSigners" : false,
"rootPackageName" : "software.amazon.awssdk.services",
"serviceName" : "ApiGatewayManagementApi",
"signingName" : "execute-api",
"syncBuilder" : "DefaultApiGatewayManagementApiClientBuilder",
"syncBuilderInterface" : "ApiGatewayManagementApiClientBuilder",
"syncClient" : "DefaultApiGatewayManagementApiClient",
"syncInterface" : "ApiGatewayManagementApiClient",
"transformPackageName" : "apigatewaymanagementapi.transform",
"uid" : "apigatewaymanagementapi-2018-11-29",
"xmlProtocol" : false
},
"operations" : {
"PostToConnection" : {
"authenticated" : true,
"deprecated" : false,
"documentation" : "Sends the provided data to the specified connection.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "GoneException",
"documentation" : "The connection with the provided id no longer exists.
",
"httpStatusCode" : 410
}, {
"exceptionName" : "LimitExceededException",
"documentation" : "The client is sending more than the allowed number of requests per unit of time.
",
"httpStatusCode" : 429
}, {
"exceptionName" : "PayloadTooLargeException",
"documentation" : "The data has exceeded the maximum size allowed.
",
"httpStatusCode" : 413
}, {
"exceptionName" : "ForbiddenException",
"documentation" : "The caller is not authorized to invoke this operation.
",
"httpStatusCode" : 403
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "PostToConnectionRequest",
"variableName" : "postToConnectionRequest",
"variableType" : "PostToConnectionRequest",
"documentation" : "",
"simpleType" : "PostToConnectionRequest",
"variableSetterType" : "PostToConnectionRequest"
},
"methodName" : "postToConnection",
"operationName" : "PostToConnection",
"paginated" : false,
"returnType" : {
"returnType" : "PostToConnectionResponse",
"documentation" : null
},
"syncReturnType" : "PostToConnectionResponse"
}
},
"shapes" : {
"ForbiddenException" : {
"c2jName" : "ForbiddenException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The caller is not authorized to invoke this operation.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "ForbiddenException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : 403,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "ForbiddenException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "ForbiddenException",
"variableName" : "forbiddenException",
"variableType" : "ForbiddenException",
"documentation" : null,
"simpleType" : "ForbiddenException",
"variableSetterType" : "ForbiddenException"
},
"wrapper" : false
},
"GoneException" : {
"c2jName" : "GoneException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The connection with the provided id no longer exists.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "GoneException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : 410,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "GoneException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "GoneException",
"variableName" : "goneException",
"variableType" : "GoneException",
"documentation" : null,
"simpleType" : "GoneException",
"variableSetterType" : "GoneException"
},
"wrapper" : false
},
"LimitExceededException" : {
"c2jName" : "LimitExceededException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The client is sending more than the allowed number of requests per unit of time.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "LimitExceededException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : 429,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "LimitExceededException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "LimitExceededException",
"variableName" : "limitExceededException",
"variableType" : "LimitExceededException",
"documentation" : null,
"simpleType" : "LimitExceededException",
"variableSetterType" : "LimitExceededException"
},
"wrapper" : false
},
"PayloadTooLargeException" : {
"c2jName" : "PayloadTooLargeException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "The data has exceeded the maximum size allowed.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "PayloadTooLargeException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : 413,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "PayloadTooLargeException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "PayloadTooLargeException",
"variableName" : "payloadTooLargeException",
"variableType" : "PayloadTooLargeException",
"documentation" : null,
"simpleType" : "PayloadTooLargeException",
"variableSetterType" : "PayloadTooLargeException"
},
"wrapper" : false
},
"PostToConnectionRequest" : {
"c2jName" : "PostToConnectionRequest",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : true,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "PostToConnection",
"locationName" : null,
"requestUri" : "/@connections/{connectionId}",
"target" : null,
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"beanStyleGetterMethodName" : "getData",
"beanStyleSetterMethodName" : "setData",
"c2jName" : "Data",
"c2jShape" : "Data",
"defaultConsumerFluentSetterDocumentation" : "The data to be sent to the client specified by its connection id.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #data(SdkBytes)}.\n@param data a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #data(SdkBytes)",
"deprecated" : false,
"documentation" : "The data to be sent to the client specified by its connection id.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "data",
"fluentSetterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@param data The data to be sent to the client specified by its connection id.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "data",
"getterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@return The data to be sent to the client specified by its connection id.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : true,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Data",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Data",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : true,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Data",
"sensitive" : false,
"setterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@param data The data to be sent to the client specified by its connection id.",
"setterMethodName" : "setData",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "data",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "data",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "The data to be sent to the client specified by its connection id.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getConnectionId",
"beanStyleSetterMethodName" : "setConnectionId",
"c2jName" : "ConnectionId",
"c2jShape" : "__string",
"defaultConsumerFluentSetterDocumentation" : "The identifier of the connection that a specific client is using.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionId(String)}.\n@param connectionId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionId(String)",
"deprecated" : false,
"documentation" : "The identifier of the connection that a specific client is using.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "connectionId",
"fluentSetterDocumentation" : "The identifier of the connection that a specific client is using.
\n@param connectionId The identifier of the connection that a specific client is using.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "connectionId",
"getterDocumentation" : "The identifier of the connection that a specific client is using.
\n@return The identifier of the connection that a specific client is using.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : "uri",
"marshallLocation" : "PATH",
"marshallLocationName" : "connectionId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "connectionId",
"uri" : true
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionId",
"sensitive" : false,
"setterDocumentation" : "The identifier of the connection that a specific client is using.
\n@param connectionId The identifier of the connection that a specific client is using.",
"setterMethodName" : "setConnectionId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionId",
"variableType" : "String",
"documentation" : "The identifier of the connection that a specific client is using.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ConnectionId" : {
"beanStyleGetterMethodName" : "getConnectionId",
"beanStyleSetterMethodName" : "setConnectionId",
"c2jName" : "ConnectionId",
"c2jShape" : "__string",
"defaultConsumerFluentSetterDocumentation" : "The identifier of the connection that a specific client is using.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionId(String)}.\n@param connectionId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionId(String)",
"deprecated" : false,
"documentation" : "The identifier of the connection that a specific client is using.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "connectionId",
"fluentSetterDocumentation" : "The identifier of the connection that a specific client is using.
\n@param connectionId The identifier of the connection that a specific client is using.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "connectionId",
"getterDocumentation" : "The identifier of the connection that a specific client is using.
\n@return The identifier of the connection that a specific client is using.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : "uri",
"marshallLocation" : "PATH",
"marshallLocationName" : "connectionId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "connectionId",
"uri" : true
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionId",
"sensitive" : false,
"setterDocumentation" : "The identifier of the connection that a specific client is using.
\n@param connectionId The identifier of the connection that a specific client is using.",
"setterMethodName" : "setConnectionId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionId",
"variableType" : "String",
"documentation" : "The identifier of the connection that a specific client is using.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
},
"Data" : {
"beanStyleGetterMethodName" : "getData",
"beanStyleSetterMethodName" : "setData",
"c2jName" : "Data",
"c2jShape" : "Data",
"defaultConsumerFluentSetterDocumentation" : "The data to be sent to the client specified by its connection id.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #data(SdkBytes)}.\n@param data a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #data(SdkBytes)",
"deprecated" : false,
"documentation" : "The data to be sent to the client specified by its connection id.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "data",
"fluentSetterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@param data The data to be sent to the client specified by its connection id.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "data",
"getterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@return The data to be sent to the client specified by its connection id.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : true,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Data",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Data",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : true,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Data",
"sensitive" : false,
"setterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@param data The data to be sent to the client specified by its connection id.",
"setterMethodName" : "setData",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "data",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "data",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "The data to be sent to the client specified by its connection id.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"beanStyleGetterMethodName" : "getData",
"beanStyleSetterMethodName" : "setData",
"c2jName" : "Data",
"c2jShape" : "Data",
"defaultConsumerFluentSetterDocumentation" : "The data to be sent to the client specified by its connection id.
\nThis is a convenience that creates an instance of the {@link SdkBytes.Builder} avoiding the need to create one manually via {@link SdkBytes#builder()}.\n\nWhen the {@link Consumer} completes, {@link SdkBytes.Builder#build()} is called immediately and its result is passed to {@link #data(SdkBytes)}.\n@param data a consumer that will call methods on {@link SdkBytes.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #data(SdkBytes)",
"deprecated" : false,
"documentation" : "The data to be sent to the client specified by its connection id.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "data",
"fluentSetterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@param data The data to be sent to the client specified by its connection id.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "data",
"getterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@return The data to be sent to the client specified by its connection id.",
"getterModel" : {
"returnType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : true,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Data",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "Data",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : true,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_BYTES",
"name" : "Data",
"sensitive" : false,
"setterDocumentation" : "The data to be sent to the client specified by its connection id.
\n@param data The data to be sent to the client specified by its connection id.",
"setterMethodName" : "setData",
"setterModel" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "data",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : null,
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "software.amazon.awssdk.core.SdkBytes",
"variableName" : "data",
"variableType" : "software.amazon.awssdk.core.SdkBytes",
"documentation" : "The data to be sent to the client specified by its connection id.
",
"simpleType" : "SdkBytes",
"variableSetterType" : "software.amazon.awssdk.core.SdkBytes"
},
"xmlNameSpaceUri" : null
}, {
"beanStyleGetterMethodName" : "getConnectionId",
"beanStyleSetterMethodName" : "setConnectionId",
"c2jName" : "ConnectionId",
"c2jShape" : "__string",
"defaultConsumerFluentSetterDocumentation" : "The identifier of the connection that a specific client is using.
\nThis is a convenience that creates an instance of the {@link String.Builder} avoiding the need to create one manually via {@link String#builder()}.\n\nWhen the {@link Consumer} completes, {@link String.Builder#build()} is called immediately and its result is passed to {@link #connectionId(String)}.\n@param connectionId a consumer that will call methods on {@link String.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #connectionId(String)",
"deprecated" : false,
"documentation" : "The identifier of the connection that a specific client is using.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "connectionId",
"fluentSetterDocumentation" : "The identifier of the connection that a specific client is using.
\n@param connectionId The identifier of the connection that a specific client is using.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "connectionId",
"getterDocumentation" : "The identifier of the connection that a specific client is using.
\n@return The identifier of the connection that a specific client is using.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : "uri",
"marshallLocation" : "PATH",
"marshallLocationName" : "connectionId",
"queryString" : false,
"statusCode" : false,
"unmarshallLocationName" : "connectionId",
"uri" : true
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ConnectionId",
"sensitive" : false,
"setterDocumentation" : "The identifier of the connection that a specific client is using.
\n@param connectionId The identifier of the connection that a specific client is using.",
"setterMethodName" : "setConnectionId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "connectionId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "connectionId",
"variableType" : "String",
"documentation" : "The identifier of the connection that a specific client is using.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ConnectionId", "Data" ],
"shapeName" : "PostToConnectionRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "PostToConnectionRequest",
"variableName" : "postToConnectionRequest",
"variableType" : "PostToConnectionRequest",
"documentation" : null,
"simpleType" : "PostToConnectionRequest",
"variableSetterType" : "PostToConnectionRequest"
},
"wrapper" : false
},
"PostToConnectionResponse" : {
"c2jName" : "PostToConnectionResponse",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : null,
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "PostToConnectionResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "PostToConnectionResponse",
"variableName" : "postToConnectionResponse",
"variableType" : "PostToConnectionResponse",
"documentation" : null,
"simpleType" : "PostToConnectionResponse",
"variableSetterType" : "PostToConnectionResponse"
},
"wrapper" : false
}
},
"customAuthorizers" : { },
"customRetryPolicy" : null,
"examples" : {
"examples" : { },
"version" : null
},
"fileHeader" : "/*\n * Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\").\n * You may not use this file except in compliance with the License.\n * A copy of the License is located at\n *\n * http://aws.amazon.com/apache2.0\n *\n * or in the \"license\" file accompanying this file. This file is distributed\n * on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either\n * express or implied. See the License for the specific language governing\n * permissions and limitations under the License.\n */\n",
"sdkBaseResponseFqcn" : "software.amazon.awssdk.awscore.AwsResponse",
"sdkModeledExceptionBaseClassName" : "ApiGatewayManagementApiException",
"sdkModeledExceptionBaseFqcn" : "software.amazon.awssdk.services.apigatewaymanagementapi.model.ApiGatewayManagementApiException",
"sdkRequestBaseClassName" : "ApiGatewayManagementApiRequest",
"sdkResponseBaseClassName" : "ApiGatewayManagementApiResponse"
}