models.transfer-2018-11-05-intermediate.json Maven / Gradle / Ivy
Show all versions of transfer Show documentation
{
"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,
"utilitiesMethod" : null,
"verifiedSimpleMethods" : [ "listServers" ]
},
"metadata" : {
"apiVersion" : "2018-11-05",
"asyncBuilder" : "DefaultTransferAsyncClientBuilder",
"asyncBuilderInterface" : "TransferAsyncClientBuilder",
"asyncClient" : "DefaultTransferAsyncClient",
"asyncInterface" : "TransferAsyncClient",
"authPolicyPackageName" : null,
"authType" : "V4",
"baseBuilder" : "DefaultTransferBaseClientBuilder",
"baseBuilderInterface" : "TransferBaseClientBuilder",
"baseExceptionName" : "TransferException",
"baseRequestName" : "TransferRequest",
"baseResponseName" : "TransferResponse",
"cborProtocol" : false,
"clientPackageName" : "transfer",
"contentType" : null,
"defaultEndpoint" : null,
"defaultEndpointWithoutHttpProtocol" : null,
"defaultRegion" : null,
"descriptiveServiceName" : "AWS Transfer",
"documentation" : "AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and set up.
",
"endpointPrefix" : "transfer",
"fullAuthPolicyPackageName" : "software.amazon.awssdk.services",
"fullClientPackageName" : "software.amazon.awssdk.services.transfer",
"fullModelPackageName" : "software.amazon.awssdk.services.transfer.model",
"fullPaginatorsPackageName" : "software.amazon.awssdk.services.transfer.paginators",
"fullRequestTransformPackageName" : "software.amazon.awssdk.services.transfer.transform",
"fullTransformPackageName" : "software.amazon.awssdk.services.transfer.transform",
"ionProtocol" : false,
"jsonProtocol" : true,
"jsonVersion" : "1.1",
"modelPackageName" : "transfer.model",
"paginatorsPackageName" : "transfer.paginators",
"protocol" : "json",
"queryProtocol" : false,
"requestTransformPackageName" : "transfer.transform",
"requiresApiKey" : false,
"requiresIamSigners" : false,
"rootPackageName" : "software.amazon.awssdk.services",
"serviceId" : "Transfer",
"serviceName" : "Transfer",
"signingName" : "transfer",
"syncBuilder" : "DefaultTransferClientBuilder",
"syncBuilderInterface" : "TransferClientBuilder",
"syncClient" : "DefaultTransferClient",
"syncInterface" : "TransferClient",
"transformPackageName" : "transfer.transform",
"uid" : "transfer-2018-11-05",
"xmlProtocol" : false
},
"operations" : {
"CreateServer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceExistsException",
"documentation" : "The requested resource does not exist.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateServerRequest",
"variableName" : "createServerRequest",
"variableType" : "CreateServerRequest",
"documentation" : "",
"simpleType" : "CreateServerRequest",
"variableSetterType" : "CreateServerRequest"
},
"methodName" : "createServer",
"operationName" : "CreateServer",
"paginated" : false,
"returnType" : {
"returnType" : "CreateServerResponse",
"documentation" : null
},
"syncReturnType" : "CreateServerResponse"
},
"CreateUser" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP) server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceExistsException",
"documentation" : "The requested resource does not exist.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "CreateUserRequest",
"variableName" : "createUserRequest",
"variableType" : "CreateUserRequest",
"documentation" : "",
"simpleType" : "CreateUserRequest",
"variableSetterType" : "CreateUserRequest"
},
"methodName" : "createUser",
"operationName" : "CreateUser",
"paginated" : false,
"returnType" : {
"returnType" : "CreateUserResponse",
"documentation" : null
},
"syncReturnType" : "CreateUserResponse"
},
"DeleteServer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the Secure File Transfer Protocol (SFTP) server that you specify.
No response returns from this operation.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteServerRequest",
"variableName" : "deleteServerRequest",
"variableType" : "DeleteServerRequest",
"documentation" : "",
"simpleType" : "DeleteServerRequest",
"variableSetterType" : "DeleteServerRequest"
},
"methodName" : "deleteServer",
"operationName" : "DeleteServer",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteServerResponse",
"documentation" : null
},
"syncReturnType" : "DeleteServerResponse"
},
"DeleteSshPublicKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes a user's Secure Shell (SSH) public key.
No response is returned from this operation.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ThrottlingException",
"documentation" : "The request was denied due to request throttling.
HTTP Status Code: 400
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteSshPublicKeyRequest",
"variableName" : "deleteSshPublicKeyRequest",
"variableType" : "DeleteSshPublicKeyRequest",
"documentation" : "",
"simpleType" : "DeleteSshPublicKeyRequest",
"variableSetterType" : "DeleteSshPublicKeyRequest"
},
"methodName" : "deleteSshPublicKey",
"operationName" : "DeleteSshPublicKey",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteSshPublicKeyResponse",
"documentation" : null
},
"syncReturnType" : "DeleteSshPublicKeyResponse"
},
"DeleteUser" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Deletes the user belonging to the server you specify.
No response returns from this operation.
When you delete a user from a server, the user's information is lost.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DeleteUserRequest",
"variableName" : "deleteUserRequest",
"variableType" : "DeleteUserRequest",
"documentation" : "",
"simpleType" : "DeleteUserRequest",
"variableSetterType" : "DeleteUserRequest"
},
"methodName" : "deleteUser",
"operationName" : "DeleteUser",
"paginated" : false,
"returnType" : {
"returnType" : "DeleteUserResponse",
"documentation" : null
},
"syncReturnType" : "DeleteUserResponse"
},
"DescribeServer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes the server that you specify by passing the ServerId parameter.
The response contains a description of the server's properties. When you set EndpointType to VPC, the response will contain the EndpointDetails.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeServerRequest",
"variableName" : "describeServerRequest",
"variableType" : "DescribeServerRequest",
"documentation" : "",
"simpleType" : "DescribeServerRequest",
"variableSetterType" : "DescribeServerRequest"
},
"methodName" : "describeServer",
"operationName" : "DescribeServer",
"paginated" : false,
"returnType" : {
"returnType" : "DescribeServerResponse",
"documentation" : null
},
"syncReturnType" : "DescribeServerResponse"
},
"DescribeUser" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Describes the user assigned to a specific server, as identified by its ServerId property.
The response from this call returns the properties of the user associated with the ServerId value that was specified.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "DescribeUserRequest",
"variableName" : "describeUserRequest",
"variableType" : "DescribeUserRequest",
"documentation" : "",
"simpleType" : "DescribeUserRequest",
"variableSetterType" : "DescribeUserRequest"
},
"methodName" : "describeUser",
"operationName" : "DescribeUser",
"paginated" : false,
"returnType" : {
"returnType" : "DescribeUserResponse",
"documentation" : null
},
"syncReturnType" : "DescribeUserResponse"
},
"ImportSshPublicKey" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.
The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceExistsException",
"documentation" : "The requested resource does not exist.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ThrottlingException",
"documentation" : "The request was denied due to request throttling.
HTTP Status Code: 400
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ImportSshPublicKeyRequest",
"variableName" : "importSshPublicKeyRequest",
"variableType" : "ImportSshPublicKeyRequest",
"documentation" : "",
"simpleType" : "ImportSshPublicKeyRequest",
"variableSetterType" : "ImportSshPublicKeyRequest"
},
"methodName" : "importSshPublicKey",
"operationName" : "ImportSshPublicKey",
"paginated" : false,
"returnType" : {
"returnType" : "ImportSshPublicKeyResponse",
"documentation" : "This response identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.
"
},
"syncReturnType" : "ImportSshPublicKeyResponse"
},
"ListServers" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidNextTokenException",
"documentation" : "The NextToken parameter that was passed is invalid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListServersRequest",
"variableName" : "listServersRequest",
"variableType" : "ListServersRequest",
"documentation" : "",
"simpleType" : "ListServersRequest",
"variableSetterType" : "ListServersRequest"
},
"methodName" : "listServers",
"operationName" : "ListServers",
"paginated" : true,
"returnType" : {
"returnType" : "ListServersResponse",
"documentation" : null
},
"syncReturnType" : "ListServersResponse"
},
"ListTagsForResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidNextTokenException",
"documentation" : "The NextToken parameter that was passed is invalid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListTagsForResourceRequest",
"variableName" : "listTagsForResourceRequest",
"variableType" : "ListTagsForResourceRequest",
"documentation" : "",
"simpleType" : "ListTagsForResourceRequest",
"variableSetterType" : "ListTagsForResourceRequest"
},
"methodName" : "listTagsForResource",
"operationName" : "ListTagsForResource",
"paginated" : true,
"returnType" : {
"returnType" : "ListTagsForResourceResponse",
"documentation" : null
},
"syncReturnType" : "ListTagsForResourceResponse"
},
"ListUsers" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Lists the users for the server that you specify by passing the ServerId parameter.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidNextTokenException",
"documentation" : "The NextToken parameter that was passed is invalid.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "ListUsersRequest",
"variableName" : "listUsersRequest",
"variableType" : "ListUsersRequest",
"documentation" : "",
"simpleType" : "ListUsersRequest",
"variableSetterType" : "ListUsersRequest"
},
"methodName" : "listUsers",
"operationName" : "ListUsers",
"paginated" : true,
"returnType" : {
"returnType" : "ListUsersResponse",
"documentation" : null
},
"syncReturnType" : "ListUsersResponse"
},
"StartServer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.
No response is returned from this call.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ThrottlingException",
"documentation" : "The request was denied due to request throttling.
HTTP Status Code: 400
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "StartServerRequest",
"variableName" : "startServerRequest",
"variableType" : "StartServerRequest",
"documentation" : "",
"simpleType" : "StartServerRequest",
"variableSetterType" : "StartServerRequest"
},
"methodName" : "startServer",
"operationName" : "StartServer",
"paginated" : false,
"returnType" : {
"returnType" : "StartServerResponse",
"documentation" : null
},
"syncReturnType" : "StartServerResponse"
},
"StopServer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.
The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.
No response is returned from this call.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ThrottlingException",
"documentation" : "The request was denied due to request throttling.
HTTP Status Code: 400
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "StopServerRequest",
"variableName" : "stopServerRequest",
"variableType" : "StopServerRequest",
"documentation" : "",
"simpleType" : "StopServerRequest",
"variableSetterType" : "StopServerRequest"
},
"methodName" : "stopServer",
"operationName" : "StopServer",
"paginated" : false,
"returnType" : {
"returnType" : "StopServerResponse",
"documentation" : null
},
"syncReturnType" : "StopServerResponse"
},
"TagResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
There is no response returned from this call.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TagResourceRequest",
"variableName" : "tagResourceRequest",
"variableType" : "TagResourceRequest",
"documentation" : "",
"simpleType" : "TagResourceRequest",
"variableSetterType" : "TagResourceRequest"
},
"methodName" : "tagResource",
"operationName" : "TagResource",
"paginated" : false,
"returnType" : {
"returnType" : "TagResourceResponse",
"documentation" : null
},
"syncReturnType" : "TagResourceResponse"
},
"TestIdentityProvider" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "TestIdentityProviderRequest",
"variableName" : "testIdentityProviderRequest",
"variableType" : "TestIdentityProviderRequest",
"documentation" : "",
"simpleType" : "TestIdentityProviderRequest",
"variableSetterType" : "TestIdentityProviderRequest"
},
"methodName" : "testIdentityProvider",
"operationName" : "TestIdentityProvider",
"paginated" : false,
"returnType" : {
"returnType" : "TestIdentityProviderResponse",
"documentation" : null
},
"syncReturnType" : "TestIdentityProviderResponse"
},
"UntagResource" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.
No response is returned from this call.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UntagResourceRequest",
"variableName" : "untagResourceRequest",
"variableType" : "UntagResourceRequest",
"documentation" : "",
"simpleType" : "UntagResourceRequest",
"variableSetterType" : "UntagResourceRequest"
},
"methodName" : "untagResource",
"operationName" : "UntagResource",
"paginated" : false,
"returnType" : {
"returnType" : "UntagResourceResponse",
"documentation" : null
},
"syncReturnType" : "UntagResourceResponse"
},
"UpdateServer" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Updates the server properties after that server has been created.
The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ConflictException",
"documentation" : "This exception is thrown when the UpdatServer is called for a server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceExistsException",
"documentation" : "The requested resource does not exist.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ThrottlingException",
"documentation" : "The request was denied due to request throttling.
HTTP Status Code: 400
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateServerRequest",
"variableName" : "updateServerRequest",
"variableType" : "UpdateServerRequest",
"documentation" : "",
"simpleType" : "UpdateServerRequest",
"variableSetterType" : "UpdateServerRequest"
},
"methodName" : "updateServer",
"operationName" : "UpdateServer",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateServerResponse",
"documentation" : null
},
"syncReturnType" : "UpdateServerResponse"
},
"UpdateUser" : {
"authType" : "IAM",
"authenticated" : true,
"deprecated" : false,
"documentation" : "Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.
The response returns the ServerId and the UserName for the updated user.
",
"endpointDiscovery" : null,
"endpointOperation" : false,
"endpointTrait" : null,
"exceptions" : [ {
"exceptionName" : "ServiceUnavailableException",
"documentation" : "The request has failed because the AWS Transfer for SFTP service is not available.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InternalServiceErrorException",
"documentation" : "This exception is thrown when an error occurs in the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "InvalidRequestException",
"documentation" : "This exception is thrown when the client submits a malformed request.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ResourceNotFoundException",
"documentation" : "This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.
",
"httpStatusCode" : null
}, {
"exceptionName" : "ThrottlingException",
"documentation" : "The request was denied due to request throttling.
HTTP Status Code: 400
",
"httpStatusCode" : null
} ],
"hasBlobMemberAsPayload" : false,
"input" : {
"variableDeclarationType" : "UpdateUserRequest",
"variableName" : "updateUserRequest",
"variableType" : "UpdateUserRequest",
"documentation" : "",
"simpleType" : "UpdateUserRequest",
"variableSetterType" : "UpdateUserRequest"
},
"methodName" : "updateUser",
"operationName" : "UpdateUser",
"paginated" : false,
"returnType" : {
"returnType" : "UpdateUserResponse",
"documentation" : " UpdateUserResponse returns the user name and server identifier for the request to update a user's properties.
"
},
"syncReturnType" : "UpdateUserResponse"
}
},
"shapes" : {
"ConflictException" : {
"c2jName" : "ConflictException",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "This exception is thrown when the UpdatServer is called for a server that has VPC as the endpoint type and the server's VpcEndpointID is not in the available state.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : "ConflictException",
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "Message" ],
"shapeName" : "ConflictException",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "ConflictException",
"variableName" : "conflictException",
"variableType" : "ConflictException",
"documentation" : null,
"simpleType" : "ConflictException",
"variableSetterType" : "ConflictException"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateServerRequest" : {
"c2jName" : "CreateServerRequest",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "CreateServer",
"locationName" : null,
"requestUri" : "/",
"target" : "TransferService.CreateServer",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointDetails",
"beanStyleSetterMethodName" : "setEndpointDetails",
"c2jName" : "EndpointDetails",
"c2jShape" : "EndpointDetails",
"defaultConsumerFluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\nThis is a convenience that creates an instance of the {@link EndpointDetails.Builder} avoiding the need to create one manually via {@link EndpointDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link EndpointDetails.Builder#build()} is called immediately and its result is passed to {@link #endpointDetails(EndpointDetails)}.\n@param endpointDetails a consumer that will call methods on {@link EndpointDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #endpointDetails(EndpointDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@return The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@deprecated Use {@link #endpointDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #endpointDetails(EndpointDetails)}\n",
"documentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "endpointDetails",
"fluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "endpointDetails",
"getterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@return The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.",
"getterModel" : {
"returnType" : "EndpointDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "EndpointDetails",
"sensitive" : false,
"setterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.",
"setterMethodName" : "setEndpointDetails",
"setterModel" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : null,
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
",
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointTypeAsString",
"beanStyleSetterMethodName" : "setEndpointType",
"c2jName" : "EndpointType",
"c2jShape" : "EndpointType",
"defaultConsumerFluentSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\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 #endpointTypeAsString(String)}.\n@param endpointType 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 #endpointType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@deprecated Use {@link #endpointTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType\n@deprecated Use {@link #endpointType(String)}\n",
"documentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
",
"endpointDiscoveryId" : false,
"enumType" : "EndpointType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointType",
"fluentEnumGetterMethodName" : "endpointType",
"fluentEnumSetterMethodName" : "endpointType",
"fluentGetterMethodName" : "endpointTypeAsString",
"fluentSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType",
"fluentSetterMethodName" : "endpointType",
"getterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EndpointType",
"sensitive" : false,
"setterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType",
"setterMethodName" : "setEndpointType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHostKey",
"beanStyleSetterMethodName" : "setHostKey",
"c2jName" : "HostKey",
"c2jShape" : "HostKey",
"defaultConsumerFluentSetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\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 #hostKey(String)}.\n@param hostKey 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 #hostKey(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@return The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@deprecated Use {@link #hostKey()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #hostKey(String)}\n",
"documentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HostKey property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHostKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "hostKey",
"fluentSetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "hostKey",
"getterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@return The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HostKey",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HostKey",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HostKey",
"sensitive" : true,
"setterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.",
"setterMethodName" : "setHostKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "hostKey",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "hostKey",
"variableType" : "String",
"documentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderDetails",
"beanStyleSetterMethodName" : "setIdentityProviderDetails",
"c2jName" : "IdentityProviderDetails",
"c2jShape" : "IdentityProviderDetails",
"defaultConsumerFluentSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\nThis is a convenience that creates an instance of the {@link IdentityProviderDetails.Builder} avoiding the need to create one manually via {@link IdentityProviderDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link IdentityProviderDetails.Builder#build()} is called immediately and its result is passed to {@link #identityProviderDetails(IdentityProviderDetails)}.\n@param identityProviderDetails a consumer that will call methods on {@link IdentityProviderDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityProviderDetails(IdentityProviderDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@return This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@deprecated Use {@link #identityProviderDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #identityProviderDetails(IdentityProviderDetails)}\n",
"documentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityProviderDetails",
"fluentSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityProviderDetails",
"getterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@return This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.",
"getterModel" : {
"returnType" : "IdentityProviderDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "IdentityProviderDetails",
"sensitive" : false,
"setterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.",
"setterMethodName" : "setIdentityProviderDetails",
"setterModel" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : null,
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
",
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderTypeAsString",
"beanStyleSetterMethodName" : "setIdentityProviderType",
"c2jName" : "IdentityProviderType",
"c2jShape" : "IdentityProviderType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\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 #identityProviderTypeAsString(String)}.\n@param identityProviderType 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 #identityProviderType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderType(String)}\n",
"documentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
"endpointDiscoveryId" : false,
"enumType" : "IdentityProviderType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderType",
"fluentEnumGetterMethodName" : "identityProviderType",
"fluentEnumSetterMethodName" : "identityProviderType",
"fluentGetterMethodName" : "identityProviderTypeAsString",
"fluentSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType",
"fluentSetterMethodName" : "identityProviderType",
"getterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityProviderType",
"sensitive" : false,
"setterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType",
"setterMethodName" : "setIdentityProviderType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLoggingRole",
"beanStyleSetterMethodName" : "setLoggingRole",
"c2jName" : "LoggingRole",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\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 #loggingRole(String)}.\n@param loggingRole 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 #loggingRole(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@return A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@deprecated Use {@link #loggingRole()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #loggingRole(String)}\n",
"documentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the LoggingRole property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLoggingRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "loggingRole",
"fluentSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "loggingRole",
"getterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@return A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "LoggingRole",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "LoggingRole",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "LoggingRole",
"sensitive" : false,
"setterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.",
"setterMethodName" : "setLoggingRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for servers.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "Key-value pairs that can be used to group and search for servers.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for servers.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "Key-value pairs that can be used to group and search for servers.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"EndpointDetails" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointDetails",
"beanStyleSetterMethodName" : "setEndpointDetails",
"c2jName" : "EndpointDetails",
"c2jShape" : "EndpointDetails",
"defaultConsumerFluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\nThis is a convenience that creates an instance of the {@link EndpointDetails.Builder} avoiding the need to create one manually via {@link EndpointDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link EndpointDetails.Builder#build()} is called immediately and its result is passed to {@link #endpointDetails(EndpointDetails)}.\n@param endpointDetails a consumer that will call methods on {@link EndpointDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #endpointDetails(EndpointDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@return The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@deprecated Use {@link #endpointDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #endpointDetails(EndpointDetails)}\n",
"documentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "endpointDetails",
"fluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "endpointDetails",
"getterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@return The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.",
"getterModel" : {
"returnType" : "EndpointDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "EndpointDetails",
"sensitive" : false,
"setterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.",
"setterMethodName" : "setEndpointDetails",
"setterModel" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : null,
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
",
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"EndpointType" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointTypeAsString",
"beanStyleSetterMethodName" : "setEndpointType",
"c2jName" : "EndpointType",
"c2jShape" : "EndpointType",
"defaultConsumerFluentSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\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 #endpointTypeAsString(String)}.\n@param endpointType 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 #endpointType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@deprecated Use {@link #endpointTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType\n@deprecated Use {@link #endpointType(String)}\n",
"documentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
",
"endpointDiscoveryId" : false,
"enumType" : "EndpointType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointType",
"fluentEnumGetterMethodName" : "endpointType",
"fluentEnumSetterMethodName" : "endpointType",
"fluentGetterMethodName" : "endpointTypeAsString",
"fluentSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType",
"fluentSetterMethodName" : "endpointType",
"getterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EndpointType",
"sensitive" : false,
"setterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType",
"setterMethodName" : "setEndpointType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"HostKey" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHostKey",
"beanStyleSetterMethodName" : "setHostKey",
"c2jName" : "HostKey",
"c2jShape" : "HostKey",
"defaultConsumerFluentSetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\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 #hostKey(String)}.\n@param hostKey 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 #hostKey(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@return The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@deprecated Use {@link #hostKey()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #hostKey(String)}\n",
"documentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HostKey property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHostKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "hostKey",
"fluentSetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "hostKey",
"getterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@return The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HostKey",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HostKey",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HostKey",
"sensitive" : true,
"setterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.",
"setterMethodName" : "setHostKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "hostKey",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "hostKey",
"variableType" : "String",
"documentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"IdentityProviderDetails" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderDetails",
"beanStyleSetterMethodName" : "setIdentityProviderDetails",
"c2jName" : "IdentityProviderDetails",
"c2jShape" : "IdentityProviderDetails",
"defaultConsumerFluentSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\nThis is a convenience that creates an instance of the {@link IdentityProviderDetails.Builder} avoiding the need to create one manually via {@link IdentityProviderDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link IdentityProviderDetails.Builder#build()} is called immediately and its result is passed to {@link #identityProviderDetails(IdentityProviderDetails)}.\n@param identityProviderDetails a consumer that will call methods on {@link IdentityProviderDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityProviderDetails(IdentityProviderDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@return This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@deprecated Use {@link #identityProviderDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #identityProviderDetails(IdentityProviderDetails)}\n",
"documentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityProviderDetails",
"fluentSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityProviderDetails",
"getterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@return This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.",
"getterModel" : {
"returnType" : "IdentityProviderDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "IdentityProviderDetails",
"sensitive" : false,
"setterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.",
"setterMethodName" : "setIdentityProviderDetails",
"setterModel" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : null,
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
",
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"IdentityProviderType" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderTypeAsString",
"beanStyleSetterMethodName" : "setIdentityProviderType",
"c2jName" : "IdentityProviderType",
"c2jShape" : "IdentityProviderType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\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 #identityProviderTypeAsString(String)}.\n@param identityProviderType 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 #identityProviderType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderType(String)}\n",
"documentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
"endpointDiscoveryId" : false,
"enumType" : "IdentityProviderType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderType",
"fluentEnumGetterMethodName" : "identityProviderType",
"fluentEnumSetterMethodName" : "identityProviderType",
"fluentGetterMethodName" : "identityProviderTypeAsString",
"fluentSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType",
"fluentSetterMethodName" : "identityProviderType",
"getterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityProviderType",
"sensitive" : false,
"setterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType",
"setterMethodName" : "setIdentityProviderType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"LoggingRole" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLoggingRole",
"beanStyleSetterMethodName" : "setLoggingRole",
"c2jName" : "LoggingRole",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\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 #loggingRole(String)}.\n@param loggingRole 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 #loggingRole(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@return A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@deprecated Use {@link #loggingRole()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #loggingRole(String)}\n",
"documentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the LoggingRole property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLoggingRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "loggingRole",
"fluentSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "loggingRole",
"getterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@return A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "LoggingRole",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "LoggingRole",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "LoggingRole",
"sensitive" : false,
"setterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.",
"setterMethodName" : "setLoggingRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Tags" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for servers.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "Key-value pairs that can be used to group and search for servers.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for servers.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "Key-value pairs that can be used to group and search for servers.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointDetails",
"beanStyleSetterMethodName" : "setEndpointDetails",
"c2jName" : "EndpointDetails",
"c2jShape" : "EndpointDetails",
"defaultConsumerFluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\nThis is a convenience that creates an instance of the {@link EndpointDetails.Builder} avoiding the need to create one manually via {@link EndpointDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link EndpointDetails.Builder#build()} is called immediately and its result is passed to {@link #endpointDetails(EndpointDetails)}.\n@param endpointDetails a consumer that will call methods on {@link EndpointDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #endpointDetails(EndpointDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@return The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@deprecated Use {@link #endpointDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #endpointDetails(EndpointDetails)}\n",
"documentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "endpointDetails",
"fluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "endpointDetails",
"getterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@return The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.",
"getterModel" : {
"returnType" : "EndpointDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "EndpointDetails",
"sensitive" : false,
"setterDocumentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.",
"setterMethodName" : "setEndpointDetails",
"setterModel" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : null,
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : "The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to invoke the UpdateServer API and attach an Elastic IP to your server's endpoint.
",
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointTypeAsString",
"beanStyleSetterMethodName" : "setEndpointType",
"c2jName" : "EndpointType",
"c2jShape" : "EndpointType",
"defaultConsumerFluentSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\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 #endpointTypeAsString(String)}.\n@param endpointType 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 #endpointType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@deprecated Use {@link #endpointTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType\n@deprecated Use {@link #endpointType(String)}\n",
"documentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
",
"endpointDiscoveryId" : false,
"enumType" : "EndpointType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointType",
"fluentEnumGetterMethodName" : "endpointType",
"fluentEnumSetterMethodName" : "endpointType",
"fluentGetterMethodName" : "endpointTypeAsString",
"fluentSetterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType",
"fluentSetterMethodName" : "endpointType",
"getterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EndpointType",
"sensitive" : false,
"setterDocumentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
\n@param endpointType The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.\n@see EndpointType",
"setterMethodName" : "setEndpointType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : "The type of VPC endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your SFTP server and resources only within your VPC.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHostKey",
"beanStyleSetterMethodName" : "setHostKey",
"c2jName" : "HostKey",
"c2jShape" : "HostKey",
"defaultConsumerFluentSetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\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 #hostKey(String)}.\n@param hostKey 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 #hostKey(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@return The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@deprecated Use {@link #hostKey()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #hostKey(String)}\n",
"documentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HostKey property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHostKey",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "hostKey",
"fluentSetterDocumentation" : "The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "hostKey",
"getterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@return The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HostKey",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HostKey",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HostKey",
"sensitive" : true,
"setterDocumentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
\n@param hostKey The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command. If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.",
"setterMethodName" : "setHostKey",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "hostKey",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "hostKey",
"variableType" : "String",
"documentation" : "
The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.
If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderDetails",
"beanStyleSetterMethodName" : "setIdentityProviderDetails",
"c2jName" : "IdentityProviderDetails",
"c2jShape" : "IdentityProviderDetails",
"defaultConsumerFluentSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\nThis is a convenience that creates an instance of the {@link IdentityProviderDetails.Builder} avoiding the need to create one manually via {@link IdentityProviderDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link IdentityProviderDetails.Builder#build()} is called immediately and its result is passed to {@link #identityProviderDetails(IdentityProviderDetails)}.\n@param identityProviderDetails a consumer that will call methods on {@link IdentityProviderDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityProviderDetails(IdentityProviderDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@return This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@deprecated Use {@link #identityProviderDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #identityProviderDetails(IdentityProviderDetails)}\n",
"documentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityProviderDetails",
"fluentSetterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityProviderDetails",
"getterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@return This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.",
"getterModel" : {
"returnType" : "IdentityProviderDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "IdentityProviderDetails",
"sensitive" : false,
"setterDocumentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
\n@param identityProviderDetails This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.",
"setterMethodName" : "setIdentityProviderDetails",
"setterModel" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : null,
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : "This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.
",
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderTypeAsString",
"beanStyleSetterMethodName" : "setIdentityProviderType",
"c2jName" : "IdentityProviderType",
"c2jShape" : "IdentityProviderType",
"defaultConsumerFluentSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\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 #identityProviderTypeAsString(String)}.\n@param identityProviderType 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 #identityProviderType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderType(String)}\n",
"documentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
"endpointDiscoveryId" : false,
"enumType" : "IdentityProviderType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderType",
"fluentEnumGetterMethodName" : "identityProviderType",
"fluentEnumSetterMethodName" : "identityProviderType",
"fluentGetterMethodName" : "identityProviderTypeAsString",
"fluentSetterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType",
"fluentSetterMethodName" : "identityProviderType",
"getterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityProviderType",
"sensitive" : false,
"setterDocumentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
\n@param identityProviderType Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.\n@see IdentityProviderType",
"setterMethodName" : "setIdentityProviderType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : "Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLoggingRole",
"beanStyleSetterMethodName" : "setLoggingRole",
"c2jName" : "LoggingRole",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\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 #loggingRole(String)}.\n@param loggingRole 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 #loggingRole(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@return A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@deprecated Use {@link #loggingRole()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #loggingRole(String)}\n",
"documentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the LoggingRole property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLoggingRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "loggingRole",
"fluentSetterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "loggingRole",
"getterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@return A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "LoggingRole",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "LoggingRole",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "LoggingRole",
"sensitive" : false,
"setterDocumentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
\n@param loggingRole A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.",
"setterMethodName" : "setLoggingRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : "A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for servers.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "Key-value pairs that can be used to group and search for servers.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for servers.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "Key-value pairs that can be used to group and search for servers.
\n@param tags Key-value pairs that can be used to group and search for servers.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "Key-value pairs that can be used to group and search for servers.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "CreateServerRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateServerRequest",
"variableName" : "createServerRequest",
"variableType" : "CreateServerRequest",
"documentation" : null,
"simpleType" : "CreateServerRequest",
"variableSetterType" : "CreateServerRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateServerResponse" : {
"c2jName" : "CreateServerResponse",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@return The service-assigned ID of the SFTP server that is created.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "The service-assigned ID of the SFTP server that is created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@return The service-assigned ID of the SFTP server that is created.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "The service-assigned ID of the SFTP server that is created.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@return The service-assigned ID of the SFTP server that is created.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "The service-assigned ID of the SFTP server that is created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@return The service-assigned ID of the SFTP server that is created.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "The service-assigned ID of the SFTP server that is created.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@return The service-assigned ID of the SFTP server that is created.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "The service-assigned ID of the SFTP server that is created.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@return The service-assigned ID of the SFTP server that is created.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "The service-assigned ID of the SFTP server that is created.
\n@param serverId The service-assigned ID of the SFTP server that is created.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "The service-assigned ID of the SFTP server that is created.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId" ],
"shapeName" : "CreateServerResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateServerResponse",
"variableName" : "createServerResponse",
"variableType" : "CreateServerResponse",
"documentation" : null,
"simpleType" : "CreateServerResponse",
"variableSetterType" : "CreateServerResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateUserRequest" : {
"c2jName" : "CreateUserRequest",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "CreateUser",
"locationName" : null,
"requestUri" : "/",
"target" : "TransferService.CreateUser",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHomeDirectory",
"beanStyleSetterMethodName" : "setHomeDirectory",
"c2jName" : "HomeDirectory",
"c2jShape" : "HomeDirectory",
"defaultConsumerFluentSetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\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 #homeDirectory(String)}.\n@param homeDirectory 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 #homeDirectory(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@return The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@deprecated Use {@link #homeDirectory()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #homeDirectory(String)}\n",
"documentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectory property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectory",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "homeDirectory",
"fluentSetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "homeDirectory",
"getterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@return The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectory",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectory",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HomeDirectory",
"sensitive" : false,
"setterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.",
"setterMethodName" : "setHomeDirectory",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHomeDirectoryTypeAsString",
"beanStyleSetterMethodName" : "setHomeDirectoryType",
"c2jName" : "HomeDirectoryType",
"c2jShape" : "HomeDirectoryType",
"defaultConsumerFluentSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\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 #homeDirectoryTypeAsString(String)}.\n@param homeDirectoryType 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 #homeDirectoryType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType} will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #homeDirectoryTypeAsString}.\n
\n@return The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@deprecated Use {@link #homeDirectoryTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@return Returns a reference to this object so that method calls can be chained together.\n@see HomeDirectoryType\n@deprecated Use {@link #homeDirectoryType(String)}\n",
"documentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
",
"endpointDiscoveryId" : false,
"enumType" : "HomeDirectoryType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectoryType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectoryType",
"fluentEnumGetterMethodName" : "homeDirectoryType",
"fluentEnumSetterMethodName" : "homeDirectoryType",
"fluentGetterMethodName" : "homeDirectoryTypeAsString",
"fluentSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@return Returns a reference to this object so that method calls can be chained together.\n@see HomeDirectoryType",
"fluentSetterMethodName" : "homeDirectoryType",
"getterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType} will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #homeDirectoryTypeAsString}.\n
\n@return The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectoryType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectoryType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HomeDirectoryType",
"sensitive" : false,
"setterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType",
"setterMethodName" : "setHomeDirectoryType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectoryType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectoryType",
"variableType" : "String",
"documentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getHomeDirectoryMappings",
"beanStyleSetterMethodName" : "setHomeDirectoryMappings",
"c2jName" : "HomeDirectoryMappings",
"c2jShape" : "HomeDirectoryMappings",
"defaultConsumerFluentSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #homeDirectoryMappings(List)}.\n@param homeDirectoryMappings a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #homeDirectoryMappings(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasHomeDirectoryMappings()} to see if a value was sent in this field.\n
\n@return Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@deprecated Use {@link #homeDirectoryMappings()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #homeDirectoryMappings(List)}\n",
"documentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectoryMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectoryMappings",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "homeDirectoryMappings",
"fluentSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "homeDirectoryMappings",
"getterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasHomeDirectoryMappings()} to see if a value was sent in this field.\n
\n@return Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectoryMappings",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectoryMappings",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "HomeDirectoryMapEntry",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link HomeDirectoryMapEntry.Builder} avoiding the need to create one manually via {@link HomeDirectoryMapEntry#builder()}.\n\nWhen the {@link Consumer} completes, {@link HomeDirectoryMapEntry.Builder#build()} is called immediately and its result is passed to {@link #member(HomeDirectoryMapEntry)}.\n@param member a consumer that will call methods on {@link HomeDirectoryMapEntry.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(HomeDirectoryMapEntry)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(HomeDirectoryMapEntry)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "HomeDirectoryMapEntry",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "HomeDirectoryMapEntry",
"variableName" : "member",
"variableType" : "HomeDirectoryMapEntry",
"documentation" : null,
"simpleType" : "HomeDirectoryMapEntry",
"variableSetterType" : "HomeDirectoryMapEntry"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "HomeDirectoryMapEntry",
"variableName" : "member",
"variableType" : "HomeDirectoryMapEntry",
"documentation" : "",
"simpleType" : "HomeDirectoryMapEntry",
"variableSetterType" : "HomeDirectoryMapEntry"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "HomeDirectoryMapEntry",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "HomeDirectoryMapEntry",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "HomeDirectoryMappings",
"sensitive" : false,
"setterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"setterMethodName" : "setHomeDirectoryMappings",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "homeDirectoryMappings",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "homeDirectoryMappings",
"variableType" : "java.util.List",
"documentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPolicy",
"beanStyleSetterMethodName" : "setPolicy",
"c2jName" : "Policy",
"c2jShape" : "Policy",
"defaultConsumerFluentSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\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 #policy(String)}.\n@param policy 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 #policy(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@deprecated Use {@link #policy()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #policy(String)}\n",
"documentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Policy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPolicy",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "policy",
"fluentSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "policy",
"getterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Policy",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Policy",
"sensitive" : false,
"setterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"setterMethodName" : "setPolicy",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getRole",
"beanStyleSetterMethodName" : "setRole",
"c2jName" : "Role",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\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 #role(String)}.\n@param role 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 #role(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@return The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@deprecated Use {@link #role()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #role(String)}\n",
"documentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Role property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "role",
"fluentSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "role",
"getterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@return The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Role",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Role",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Role",
"sensitive" : false,
"setterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.",
"setterMethodName" : "setRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "role",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "role",
"variableType" : "String",
"documentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@return A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@return A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getSshPublicKeyBody",
"beanStyleSetterMethodName" : "setSshPublicKeyBody",
"c2jName" : "SshPublicKeyBody",
"c2jShape" : "SshPublicKeyBody",
"defaultConsumerFluentSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\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 #sshPublicKeyBody(String)}.\n@param sshPublicKeyBody 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 #sshPublicKeyBody(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@return The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@deprecated Use {@link #sshPublicKeyBody()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #sshPublicKeyBody(String)}\n",
"documentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the SshPublicKeyBody property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasSshPublicKeyBody",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "sshPublicKeyBody",
"fluentSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "sshPublicKeyBody",
"getterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@return The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "SshPublicKeyBody",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "SshPublicKeyBody",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "SshPublicKeyBody",
"sensitive" : false,
"setterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.",
"setterMethodName" : "setSshPublicKeyBody",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyBody",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyBody",
"variableType" : "String",
"documentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@return A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@return A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"HomeDirectory" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHomeDirectory",
"beanStyleSetterMethodName" : "setHomeDirectory",
"c2jName" : "HomeDirectory",
"c2jShape" : "HomeDirectory",
"defaultConsumerFluentSetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\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 #homeDirectory(String)}.\n@param homeDirectory 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 #homeDirectory(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@return The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@deprecated Use {@link #homeDirectory()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #homeDirectory(String)}\n",
"documentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectory property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectory",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "homeDirectory",
"fluentSetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "homeDirectory",
"getterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@return The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectory",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectory",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HomeDirectory",
"sensitive" : false,
"setterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.",
"setterMethodName" : "setHomeDirectory",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"HomeDirectoryMappings" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getHomeDirectoryMappings",
"beanStyleSetterMethodName" : "setHomeDirectoryMappings",
"c2jName" : "HomeDirectoryMappings",
"c2jShape" : "HomeDirectoryMappings",
"defaultConsumerFluentSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #homeDirectoryMappings(List)}.\n@param homeDirectoryMappings a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #homeDirectoryMappings(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasHomeDirectoryMappings()} to see if a value was sent in this field.\n
\n@return Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@deprecated Use {@link #homeDirectoryMappings()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #homeDirectoryMappings(List)}\n",
"documentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectoryMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectoryMappings",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "homeDirectoryMappings",
"fluentSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "homeDirectoryMappings",
"getterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasHomeDirectoryMappings()} to see if a value was sent in this field.\n
\n@return Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectoryMappings",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectoryMappings",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "HomeDirectoryMapEntry",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link HomeDirectoryMapEntry.Builder} avoiding the need to create one manually via {@link HomeDirectoryMapEntry#builder()}.\n\nWhen the {@link Consumer} completes, {@link HomeDirectoryMapEntry.Builder#build()} is called immediately and its result is passed to {@link #member(HomeDirectoryMapEntry)}.\n@param member a consumer that will call methods on {@link HomeDirectoryMapEntry.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(HomeDirectoryMapEntry)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(HomeDirectoryMapEntry)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "HomeDirectoryMapEntry",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "HomeDirectoryMapEntry",
"variableName" : "member",
"variableType" : "HomeDirectoryMapEntry",
"documentation" : null,
"simpleType" : "HomeDirectoryMapEntry",
"variableSetterType" : "HomeDirectoryMapEntry"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "HomeDirectoryMapEntry",
"variableName" : "member",
"variableType" : "HomeDirectoryMapEntry",
"documentation" : "",
"simpleType" : "HomeDirectoryMapEntry",
"variableSetterType" : "HomeDirectoryMapEntry"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "HomeDirectoryMapEntry",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "HomeDirectoryMapEntry",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "HomeDirectoryMappings",
"sensitive" : false,
"setterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"setterMethodName" : "setHomeDirectoryMappings",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "homeDirectoryMappings",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "homeDirectoryMappings",
"variableType" : "java.util.List",
"documentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"HomeDirectoryType" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHomeDirectoryTypeAsString",
"beanStyleSetterMethodName" : "setHomeDirectoryType",
"c2jName" : "HomeDirectoryType",
"c2jShape" : "HomeDirectoryType",
"defaultConsumerFluentSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\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 #homeDirectoryTypeAsString(String)}.\n@param homeDirectoryType 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 #homeDirectoryType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType} will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #homeDirectoryTypeAsString}.\n
\n@return The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@deprecated Use {@link #homeDirectoryTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@return Returns a reference to this object so that method calls can be chained together.\n@see HomeDirectoryType\n@deprecated Use {@link #homeDirectoryType(String)}\n",
"documentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
",
"endpointDiscoveryId" : false,
"enumType" : "HomeDirectoryType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectoryType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectoryType",
"fluentEnumGetterMethodName" : "homeDirectoryType",
"fluentEnumSetterMethodName" : "homeDirectoryType",
"fluentGetterMethodName" : "homeDirectoryTypeAsString",
"fluentSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@return Returns a reference to this object so that method calls can be chained together.\n@see HomeDirectoryType",
"fluentSetterMethodName" : "homeDirectoryType",
"getterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType} will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #homeDirectoryTypeAsString}.\n
\n@return The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectoryType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectoryType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HomeDirectoryType",
"sensitive" : false,
"setterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType",
"setterMethodName" : "setHomeDirectoryType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectoryType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectoryType",
"variableType" : "String",
"documentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Policy" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPolicy",
"beanStyleSetterMethodName" : "setPolicy",
"c2jName" : "Policy",
"c2jShape" : "Policy",
"defaultConsumerFluentSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\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 #policy(String)}.\n@param policy 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 #policy(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@deprecated Use {@link #policy()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #policy(String)}\n",
"documentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Policy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPolicy",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "policy",
"fluentSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "policy",
"getterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Policy",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Policy",
"sensitive" : false,
"setterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"setterMethodName" : "setPolicy",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Role" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getRole",
"beanStyleSetterMethodName" : "setRole",
"c2jName" : "Role",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\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 #role(String)}.\n@param role 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 #role(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@return The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@deprecated Use {@link #role()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #role(String)}\n",
"documentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Role property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "role",
"fluentSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "role",
"getterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@return The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Role",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Role",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Role",
"sensitive" : false,
"setterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.",
"setterMethodName" : "setRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "role",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "role",
"variableType" : "String",
"documentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@return A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@return A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"SshPublicKeyBody" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getSshPublicKeyBody",
"beanStyleSetterMethodName" : "setSshPublicKeyBody",
"c2jName" : "SshPublicKeyBody",
"c2jShape" : "SshPublicKeyBody",
"defaultConsumerFluentSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\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 #sshPublicKeyBody(String)}.\n@param sshPublicKeyBody 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 #sshPublicKeyBody(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@return The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@deprecated Use {@link #sshPublicKeyBody()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #sshPublicKeyBody(String)}\n",
"documentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the SshPublicKeyBody property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasSshPublicKeyBody",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "sshPublicKeyBody",
"fluentSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "sshPublicKeyBody",
"getterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@return The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "SshPublicKeyBody",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "SshPublicKeyBody",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "SshPublicKeyBody",
"sensitive" : false,
"setterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.",
"setterMethodName" : "setSshPublicKeyBody",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyBody",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyBody",
"variableType" : "String",
"documentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Tags" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"UserName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@return A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@return A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHomeDirectory",
"beanStyleSetterMethodName" : "setHomeDirectory",
"c2jName" : "HomeDirectory",
"c2jShape" : "HomeDirectory",
"defaultConsumerFluentSetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\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 #homeDirectory(String)}.\n@param homeDirectory 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 #homeDirectory(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@return The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@deprecated Use {@link #homeDirectory()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #homeDirectory(String)}\n",
"documentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectory property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectory",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "homeDirectory",
"fluentSetterDocumentation" : "The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "homeDirectory",
"getterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@return The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectory",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectory",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HomeDirectory",
"sensitive" : false,
"setterDocumentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
\n@param homeDirectory The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is <your-Amazon-S3-bucket-name>/home/username.",
"setterMethodName" : "setHomeDirectory",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : "
The landing directory (folder) for a user when they log in to the server using their SFTP client.
An example is <your-Amazon-S3-bucket-name>/home/username.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHomeDirectoryTypeAsString",
"beanStyleSetterMethodName" : "setHomeDirectoryType",
"c2jName" : "HomeDirectoryType",
"c2jShape" : "HomeDirectoryType",
"defaultConsumerFluentSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\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 #homeDirectoryTypeAsString(String)}.\n@param homeDirectoryType 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 #homeDirectoryType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType} will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #homeDirectoryTypeAsString}.\n
\n@return The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@deprecated Use {@link #homeDirectoryTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@return Returns a reference to this object so that method calls can be chained together.\n@see HomeDirectoryType\n@deprecated Use {@link #homeDirectoryType(String)}\n",
"documentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
",
"endpointDiscoveryId" : false,
"enumType" : "HomeDirectoryType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectoryType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectoryType",
"fluentEnumGetterMethodName" : "homeDirectoryType",
"fluentEnumSetterMethodName" : "homeDirectoryType",
"fluentGetterMethodName" : "homeDirectoryTypeAsString",
"fluentSetterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType\n@return Returns a reference to this object so that method calls can be chained together.\n@see HomeDirectoryType",
"fluentSetterMethodName" : "homeDirectoryType",
"getterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #homeDirectoryType} will return {@link HomeDirectoryType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #homeDirectoryTypeAsString}.\n
\n@return The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectoryType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectoryType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HomeDirectoryType",
"sensitive" : false,
"setterDocumentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
\n@param homeDirectoryType The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.\n@see HomeDirectoryType",
"setterMethodName" : "setHomeDirectoryType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectoryType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectoryType",
"variableType" : "String",
"documentation" : "The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getHomeDirectoryMappings",
"beanStyleSetterMethodName" : "setHomeDirectoryMappings",
"c2jName" : "HomeDirectoryMappings",
"c2jShape" : "HomeDirectoryMappings",
"defaultConsumerFluentSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #homeDirectoryMappings(List)}.\n@param homeDirectoryMappings a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #homeDirectoryMappings(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasHomeDirectoryMappings()} to see if a value was sent in this field.\n
\n@return Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@deprecated Use {@link #homeDirectoryMappings()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #homeDirectoryMappings(List)}\n",
"documentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectoryMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectoryMappings",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "homeDirectoryMappings",
"fluentSetterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "homeDirectoryMappings",
"getterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasHomeDirectoryMappings()} to see if a value was sent in this field.\n
\n@return Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectoryMappings",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectoryMappings",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "HomeDirectoryMapEntry",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link HomeDirectoryMapEntry.Builder} avoiding the need to create one manually via {@link HomeDirectoryMapEntry#builder()}.\n\nWhen the {@link Consumer} completes, {@link HomeDirectoryMapEntry.Builder#build()} is called immediately and its result is passed to {@link #member(HomeDirectoryMapEntry)}.\n@param member a consumer that will call methods on {@link HomeDirectoryMapEntry.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(HomeDirectoryMapEntry)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(HomeDirectoryMapEntry)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "HomeDirectoryMapEntry",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "HomeDirectoryMapEntry",
"variableName" : "member",
"variableType" : "HomeDirectoryMapEntry",
"documentation" : null,
"simpleType" : "HomeDirectoryMapEntry",
"variableSetterType" : "HomeDirectoryMapEntry"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "HomeDirectoryMapEntry",
"variableName" : "member",
"variableType" : "HomeDirectoryMapEntry",
"documentation" : "",
"simpleType" : "HomeDirectoryMapEntry",
"variableSetterType" : "HomeDirectoryMapEntry"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "HomeDirectoryMapEntry",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "HomeDirectoryMapEntry",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "HomeDirectoryMappings",
"sensitive" : false,
"setterDocumentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
\n@param homeDirectoryMappings Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example. '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"setterMethodName" : "setHomeDirectoryMappings",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "homeDirectoryMappings",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "homeDirectoryMappings",
"variableType" : "java.util.List",
"documentation" : "Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.
'[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getPolicy",
"beanStyleSetterMethodName" : "setPolicy",
"c2jName" : "Policy",
"c2jShape" : "Policy",
"defaultConsumerFluentSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\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 #policy(String)}.\n@param policy 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 #policy(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@deprecated Use {@link #policy()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #policy(String)}\n",
"documentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Policy property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasPolicy",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "policy",
"fluentSetterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "policy",
"getterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@return A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Policy",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Policy",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Policy",
"sensitive" : false,
"setterDocumentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
\n@param policy A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}. For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"setterMethodName" : "setPolicy",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "policy",
"variableType" : "String",
"documentation" : "A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.
For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.
For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.
For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getRole",
"beanStyleSetterMethodName" : "setRole",
"c2jName" : "Role",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\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 #role(String)}.\n@param role 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 #role(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@return The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@deprecated Use {@link #role()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #role(String)}\n",
"documentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Role property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "role",
"fluentSetterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "role",
"getterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@return The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Role",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Role",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Role",
"sensitive" : false,
"setterDocumentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
\n@param role The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.",
"setterMethodName" : "setRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "role",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "role",
"variableType" : "String",
"documentation" : "The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@return A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@return A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
\n@param serverId A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getSshPublicKeyBody",
"beanStyleSetterMethodName" : "setSshPublicKeyBody",
"c2jName" : "SshPublicKeyBody",
"c2jShape" : "SshPublicKeyBody",
"defaultConsumerFluentSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\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 #sshPublicKeyBody(String)}.\n@param sshPublicKeyBody 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 #sshPublicKeyBody(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@return The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@deprecated Use {@link #sshPublicKeyBody()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #sshPublicKeyBody(String)}\n",
"documentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the SshPublicKeyBody property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasSshPublicKeyBody",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "sshPublicKeyBody",
"fluentSetterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "sshPublicKeyBody",
"getterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@return The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "SshPublicKeyBody",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "SshPublicKeyBody",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "SshPublicKeyBody",
"sensitive" : false,
"setterDocumentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
\n@param sshPublicKeyBody The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.",
"setterMethodName" : "setSshPublicKeyBody",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyBody",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyBody",
"variableType" : "String",
"documentation" : "The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
\n@param tags Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@return A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@return A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
\n@param userName A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "Role", "ServerId", "UserName" ],
"shapeName" : "CreateUserRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "CreateUserRequest",
"variableName" : "createUserRequest",
"variableType" : "CreateUserRequest",
"documentation" : null,
"simpleType" : "CreateUserRequest",
"variableSetterType" : "CreateUserRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"CreateUserResponse" : {
"c2jName" : "CreateUserResponse",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@return The ID of the SFTP server that the user is attached to.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "The ID of the SFTP server that the user is attached to.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@return The ID of the SFTP server that the user is attached to.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "The ID of the SFTP server that the user is attached to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@return A unique string that identifies a user account associated with an SFTP server.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user account associated with an SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@return A unique string that identifies a user account associated with an SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user account associated with an SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@return The ID of the SFTP server that the user is attached to.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "The ID of the SFTP server that the user is attached to.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@return The ID of the SFTP server that the user is attached to.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "The ID of the SFTP server that the user is attached to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"UserName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@return A unique string that identifies a user account associated with an SFTP server.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user account associated with an SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@return A unique string that identifies a user account associated with an SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user account associated with an SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@return The ID of the SFTP server that the user is attached to.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "The ID of the SFTP server that the user is attached to.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@return The ID of the SFTP server that the user is attached to.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "The ID of the SFTP server that the user is attached to.
\n@param serverId The ID of the SFTP server that the user is attached to.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "The ID of the SFTP server that the user is attached to.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@return A unique string that identifies a user account associated with an SFTP server.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user account associated with an SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@return A unique string that identifies a user account associated with an SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user account associated with an SFTP server.
\n@param userName A unique string that identifies a user account associated with an SFTP server.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user account associated with an SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId", "UserName" ],
"shapeName" : "CreateUserResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "CreateUserResponse",
"variableName" : "createUserResponse",
"variableType" : "CreateUserResponse",
"documentation" : null,
"simpleType" : "CreateUserResponse",
"variableSetterType" : "CreateUserResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteServerRequest" : {
"c2jName" : "DeleteServerRequest",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DeleteServer",
"locationName" : null,
"requestUri" : "/",
"target" : "TransferService.DeleteServer",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@return A unique system-assigned identifier for an SFTP server instance.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A unique system-assigned identifier for an SFTP server instance.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@return A unique system-assigned identifier for an SFTP server instance.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A unique system-assigned identifier for an SFTP server instance.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@return A unique system-assigned identifier for an SFTP server instance.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A unique system-assigned identifier for an SFTP server instance.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@return A unique system-assigned identifier for an SFTP server instance.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A unique system-assigned identifier for an SFTP server instance.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@return A unique system-assigned identifier for an SFTP server instance.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A unique system-assigned identifier for an SFTP server instance.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@return A unique system-assigned identifier for an SFTP server instance.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A unique system-assigned identifier for an SFTP server instance.
\n@param serverId A unique system-assigned identifier for an SFTP server instance.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A unique system-assigned identifier for an SFTP server instance.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId" ],
"shapeName" : "DeleteServerRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteServerRequest",
"variableName" : "deleteServerRequest",
"variableType" : "DeleteServerRequest",
"documentation" : null,
"simpleType" : "DeleteServerRequest",
"variableSetterType" : "DeleteServerRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteServerResponse" : {
"c2jName" : "DeleteServerResponse",
"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,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DeleteServerResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteServerResponse",
"variableName" : "deleteServerResponse",
"variableType" : "DeleteServerResponse",
"documentation" : null,
"simpleType" : "DeleteServerResponse",
"variableSetterType" : "DeleteServerResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteSshPublicKeyRequest" : {
"c2jName" : "DeleteSshPublicKeyRequest",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DeleteSshPublicKey",
"locationName" : null,
"requestUri" : "/",
"target" : "TransferService.DeleteSshPublicKey",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getSshPublicKeyId",
"beanStyleSetterMethodName" : "setSshPublicKeyId",
"c2jName" : "SshPublicKeyId",
"c2jShape" : "SshPublicKeyId",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\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 #sshPublicKeyId(String)}.\n@param sshPublicKeyId 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 #sshPublicKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@return A unique identifier used to reference your user's specific SSH key.\n@deprecated Use {@link #sshPublicKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #sshPublicKeyId(String)}\n",
"documentation" : "A unique identifier used to reference your user's specific SSH key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the SshPublicKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasSshPublicKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "sshPublicKeyId",
"fluentSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "sshPublicKeyId",
"getterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@return A unique identifier used to reference your user's specific SSH key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "SshPublicKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "SshPublicKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "SshPublicKeyId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.",
"setterMethodName" : "setSshPublicKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyId",
"variableType" : "String",
"documentation" : "A unique identifier used to reference your user's specific SSH key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@return A unique string that identifies a user whose public key is being deleted.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user whose public key is being deleted.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@return A unique string that identifies a user whose public key is being deleted.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user whose public key is being deleted.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"SshPublicKeyId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getSshPublicKeyId",
"beanStyleSetterMethodName" : "setSshPublicKeyId",
"c2jName" : "SshPublicKeyId",
"c2jShape" : "SshPublicKeyId",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\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 #sshPublicKeyId(String)}.\n@param sshPublicKeyId 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 #sshPublicKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@return A unique identifier used to reference your user's specific SSH key.\n@deprecated Use {@link #sshPublicKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #sshPublicKeyId(String)}\n",
"documentation" : "A unique identifier used to reference your user's specific SSH key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the SshPublicKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasSshPublicKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "sshPublicKeyId",
"fluentSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "sshPublicKeyId",
"getterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@return A unique identifier used to reference your user's specific SSH key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "SshPublicKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "SshPublicKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "SshPublicKeyId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.",
"setterMethodName" : "setSshPublicKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyId",
"variableType" : "String",
"documentation" : "A unique identifier used to reference your user's specific SSH key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"UserName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@return A unique string that identifies a user whose public key is being deleted.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user whose public key is being deleted.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@return A unique string that identifies a user whose public key is being deleted.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user whose public key is being deleted.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getSshPublicKeyId",
"beanStyleSetterMethodName" : "setSshPublicKeyId",
"c2jName" : "SshPublicKeyId",
"c2jShape" : "SshPublicKeyId",
"defaultConsumerFluentSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\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 #sshPublicKeyId(String)}.\n@param sshPublicKeyId 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 #sshPublicKeyId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@return A unique identifier used to reference your user's specific SSH key.\n@deprecated Use {@link #sshPublicKeyId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #sshPublicKeyId(String)}\n",
"documentation" : "A unique identifier used to reference your user's specific SSH key.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the SshPublicKeyId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasSshPublicKeyId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "sshPublicKeyId",
"fluentSetterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "sshPublicKeyId",
"getterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@return A unique identifier used to reference your user's specific SSH key.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "SshPublicKeyId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "SshPublicKeyId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "SshPublicKeyId",
"sensitive" : false,
"setterDocumentation" : "A unique identifier used to reference your user's specific SSH key.
\n@param sshPublicKeyId A unique identifier used to reference your user's specific SSH key.",
"setterMethodName" : "setSshPublicKeyId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "sshPublicKeyId",
"variableType" : "String",
"documentation" : "A unique identifier used to reference your user's specific SSH key.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@return A unique string that identifies a user whose public key is being deleted.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user whose public key is being deleted.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@return A unique string that identifies a user whose public key is being deleted.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user whose public key is being deleted.
\n@param userName A unique string that identifies a user whose public key is being deleted.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user whose public key is being deleted.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId", "SshPublicKeyId", "UserName" ],
"shapeName" : "DeleteSshPublicKeyRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteSshPublicKeyRequest",
"variableName" : "deleteSshPublicKeyRequest",
"variableType" : "DeleteSshPublicKeyRequest",
"documentation" : null,
"simpleType" : "DeleteSshPublicKeyRequest",
"variableSetterType" : "DeleteSshPublicKeyRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteSshPublicKeyResponse" : {
"c2jName" : "DeleteSshPublicKeyResponse",
"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,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DeleteSshPublicKeyResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteSshPublicKeyResponse",
"variableName" : "deleteSshPublicKeyResponse",
"variableType" : "DeleteSshPublicKeyResponse",
"documentation" : null,
"simpleType" : "DeleteSshPublicKeyResponse",
"variableSetterType" : "DeleteSshPublicKeyResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteUserRequest" : {
"c2jName" : "DeleteUserRequest",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DeleteUser",
"locationName" : null,
"requestUri" : "/",
"target" : "TransferService.DeleteUser",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@return A unique string that identifies a user that is being deleted from the server.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user that is being deleted from the server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@return A unique string that identifies a user that is being deleted from the server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user that is being deleted from the server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"UserName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@return A unique string that identifies a user that is being deleted from the server.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user that is being deleted from the server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@return A unique string that identifies a user that is being deleted from the server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user that is being deleted from the server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@return A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
\n@param serverId A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@return A unique string that identifies a user that is being deleted from the server.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "A unique string that identifies a user that is being deleted from the server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@return A unique string that identifies a user that is being deleted from the server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "A unique string that identifies a user that is being deleted from the server.
\n@param userName A unique string that identifies a user that is being deleted from the server.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "A unique string that identifies a user that is being deleted from the server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId", "UserName" ],
"shapeName" : "DeleteUserRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DeleteUserRequest",
"variableName" : "deleteUserRequest",
"variableType" : "DeleteUserRequest",
"documentation" : null,
"simpleType" : "DeleteUserRequest",
"variableSetterType" : "DeleteUserRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DeleteUserResponse" : {
"c2jName" : "DeleteUserResponse",
"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,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ ],
"membersAsMap" : { },
"nonStreamingMembers" : [ ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : null,
"shapeName" : "DeleteUserResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DeleteUserResponse",
"variableName" : "deleteUserResponse",
"variableType" : "DeleteUserResponse",
"documentation" : null,
"simpleType" : "DeleteUserResponse",
"variableSetterType" : "DeleteUserResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeServerRequest" : {
"c2jName" : "DescribeServerRequest",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DescribeServer",
"locationName" : null,
"requestUri" : "/",
"target" : "TransferService.DescribeServer",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@return A system-assigned unique identifier for an SFTP server.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@return A system-assigned unique identifier for an SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@return A system-assigned unique identifier for an SFTP server.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@return A system-assigned unique identifier for an SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@return A system-assigned unique identifier for an SFTP server.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@return A system-assigned unique identifier for an SFTP server.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server.
\n@param serverId A system-assigned unique identifier for an SFTP server.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId" ],
"shapeName" : "DescribeServerRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DescribeServerRequest",
"variableName" : "describeServerRequest",
"variableType" : "DescribeServerRequest",
"documentation" : null,
"simpleType" : "DescribeServerRequest",
"variableSetterType" : "DescribeServerRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeServerResponse" : {
"c2jName" : "DescribeServerResponse",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServer",
"beanStyleSetterMethodName" : "setServer",
"c2jName" : "Server",
"c2jShape" : "DescribedServer",
"defaultConsumerFluentSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\nThis is a convenience that creates an instance of the {@link DescribedServer.Builder} avoiding the need to create one manually via {@link DescribedServer#builder()}.\n\nWhen the {@link Consumer} completes, {@link DescribedServer.Builder#build()} is called immediately and its result is passed to {@link #server(DescribedServer)}.\n@param server a consumer that will call methods on {@link DescribedServer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #server(DescribedServer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@return An array containing the properties of the server with the ServerID you specified.\n@deprecated Use {@link #server()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #server(DescribedServer)}\n",
"documentation" : "An array containing the properties of the server with the ServerID you specified.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Server property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServer",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "server",
"fluentSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "server",
"getterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@return An array containing the properties of the server with the ServerID you specified.",
"getterModel" : {
"returnType" : "DescribedServer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Server",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Server",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Server",
"sensitive" : false,
"setterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.",
"setterMethodName" : "setServer",
"setterModel" : {
"variableDeclarationType" : "DescribedServer",
"variableName" : "server",
"variableType" : "DescribedServer",
"documentation" : null,
"simpleType" : "DescribedServer",
"variableSetterType" : "DescribedServer"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "DescribedServer",
"variableName" : "server",
"variableType" : "DescribedServer",
"documentation" : "An array containing the properties of the server with the ServerID you specified.
",
"simpleType" : "DescribedServer",
"variableSetterType" : "DescribedServer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"Server" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServer",
"beanStyleSetterMethodName" : "setServer",
"c2jName" : "Server",
"c2jShape" : "DescribedServer",
"defaultConsumerFluentSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\nThis is a convenience that creates an instance of the {@link DescribedServer.Builder} avoiding the need to create one manually via {@link DescribedServer#builder()}.\n\nWhen the {@link Consumer} completes, {@link DescribedServer.Builder#build()} is called immediately and its result is passed to {@link #server(DescribedServer)}.\n@param server a consumer that will call methods on {@link DescribedServer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #server(DescribedServer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@return An array containing the properties of the server with the ServerID you specified.\n@deprecated Use {@link #server()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #server(DescribedServer)}\n",
"documentation" : "An array containing the properties of the server with the ServerID you specified.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Server property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServer",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "server",
"fluentSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "server",
"getterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@return An array containing the properties of the server with the ServerID you specified.",
"getterModel" : {
"returnType" : "DescribedServer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Server",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Server",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Server",
"sensitive" : false,
"setterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.",
"setterMethodName" : "setServer",
"setterModel" : {
"variableDeclarationType" : "DescribedServer",
"variableName" : "server",
"variableType" : "DescribedServer",
"documentation" : null,
"simpleType" : "DescribedServer",
"variableSetterType" : "DescribedServer"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "DescribedServer",
"variableName" : "server",
"variableType" : "DescribedServer",
"documentation" : "An array containing the properties of the server with the ServerID you specified.
",
"simpleType" : "DescribedServer",
"variableSetterType" : "DescribedServer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServer",
"beanStyleSetterMethodName" : "setServer",
"c2jName" : "Server",
"c2jShape" : "DescribedServer",
"defaultConsumerFluentSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\nThis is a convenience that creates an instance of the {@link DescribedServer.Builder} avoiding the need to create one manually via {@link DescribedServer#builder()}.\n\nWhen the {@link Consumer} completes, {@link DescribedServer.Builder#build()} is called immediately and its result is passed to {@link #server(DescribedServer)}.\n@param server a consumer that will call methods on {@link DescribedServer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #server(DescribedServer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@return An array containing the properties of the server with the ServerID you specified.\n@deprecated Use {@link #server()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #server(DescribedServer)}\n",
"documentation" : "An array containing the properties of the server with the ServerID you specified.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Server property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServer",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "server",
"fluentSetterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "server",
"getterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@return An array containing the properties of the server with the ServerID you specified.",
"getterModel" : {
"returnType" : "DescribedServer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Server",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Server",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Server",
"sensitive" : false,
"setterDocumentation" : "An array containing the properties of the server with the ServerID you specified.
\n@param server An array containing the properties of the server with the ServerID you specified.",
"setterMethodName" : "setServer",
"setterModel" : {
"variableDeclarationType" : "DescribedServer",
"variableName" : "server",
"variableType" : "DescribedServer",
"documentation" : null,
"simpleType" : "DescribedServer",
"variableSetterType" : "DescribedServer"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "DescribedServer",
"variableName" : "server",
"variableType" : "DescribedServer",
"documentation" : "An array containing the properties of the server with the ServerID you specified.
",
"simpleType" : "DescribedServer",
"variableSetterType" : "DescribedServer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "Server" ],
"shapeName" : "DescribeServerResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DescribeServerResponse",
"variableName" : "describeServerResponse",
"variableType" : "DescribeServerResponse",
"documentation" : null,
"simpleType" : "DescribeServerResponse",
"variableSetterType" : "DescribeServerResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeUserRequest" : {
"c2jName" : "DescribeUserRequest",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : {
"action" : "DescribeUser",
"locationName" : null,
"requestUri" : "/",
"target" : "TransferService.DescribeUser",
"verb" : "POST",
"xmlNameSpaceUri" : null
},
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@return The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@return The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"UserName" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@return The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@return The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserName",
"beanStyleSetterMethodName" : "setUserName",
"c2jName" : "UserName",
"c2jShape" : "UserName",
"defaultConsumerFluentSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\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 #userName(String)}.\n@param userName 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 #userName(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@return The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@deprecated Use {@link #userName()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userName(String)}\n",
"documentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserName property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserName",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userName",
"fluentSetterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userName",
"getterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@return The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserName",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserName",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "UserName",
"sensitive" : false,
"setterDocumentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
\n@param userName The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.",
"setterMethodName" : "setUserName",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "userName",
"variableType" : "String",
"documentation" : "The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId", "UserName" ],
"shapeName" : "DescribeUserRequest",
"simpleMethod" : false,
"unmarshaller" : null,
"variable" : {
"variableDeclarationType" : "DescribeUserRequest",
"variableName" : "describeUserRequest",
"variableType" : "DescribeUserRequest",
"documentation" : null,
"simpleType" : "DescribeUserRequest",
"variableSetterType" : "DescribeUserRequest"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribeUserResponse" : {
"c2jName" : "DescribeUserResponse",
"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" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUser",
"beanStyleSetterMethodName" : "setUser",
"c2jName" : "User",
"c2jShape" : "DescribedUser",
"defaultConsumerFluentSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\nThis is a convenience that creates an instance of the {@link DescribedUser.Builder} avoiding the need to create one manually via {@link DescribedUser#builder()}.\n\nWhen the {@link Consumer} completes, {@link DescribedUser.Builder#build()} is called immediately and its result is passed to {@link #user(DescribedUser)}.\n@param user a consumer that will call methods on {@link DescribedUser.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #user(DescribedUser)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@return An array containing the properties of the user account for the ServerID value that you specified.\n@deprecated Use {@link #user()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #user(DescribedUser)}\n",
"documentation" : "An array containing the properties of the user account for the ServerID value that you specified.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the User property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUser",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "user",
"fluentSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "user",
"getterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@return An array containing the properties of the user account for the ServerID value that you specified.",
"getterModel" : {
"returnType" : "DescribedUser",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "User",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "User",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "User",
"sensitive" : false,
"setterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.",
"setterMethodName" : "setUser",
"setterModel" : {
"variableDeclarationType" : "DescribedUser",
"variableName" : "user",
"variableType" : "DescribedUser",
"documentation" : null,
"simpleType" : "DescribedUser",
"variableSetterType" : "DescribedUser"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "DescribedUser",
"variableName" : "user",
"variableType" : "DescribedUser",
"documentation" : "An array containing the properties of the user account for the ServerID value that you specified.
",
"simpleType" : "DescribedUser",
"variableSetterType" : "DescribedUser"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"User" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUser",
"beanStyleSetterMethodName" : "setUser",
"c2jName" : "User",
"c2jShape" : "DescribedUser",
"defaultConsumerFluentSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\nThis is a convenience that creates an instance of the {@link DescribedUser.Builder} avoiding the need to create one manually via {@link DescribedUser#builder()}.\n\nWhen the {@link Consumer} completes, {@link DescribedUser.Builder#build()} is called immediately and its result is passed to {@link #user(DescribedUser)}.\n@param user a consumer that will call methods on {@link DescribedUser.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #user(DescribedUser)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@return An array containing the properties of the user account for the ServerID value that you specified.\n@deprecated Use {@link #user()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #user(DescribedUser)}\n",
"documentation" : "An array containing the properties of the user account for the ServerID value that you specified.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the User property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUser",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "user",
"fluentSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "user",
"getterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@return An array containing the properties of the user account for the ServerID value that you specified.",
"getterModel" : {
"returnType" : "DescribedUser",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "User",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "User",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "User",
"sensitive" : false,
"setterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.",
"setterMethodName" : "setUser",
"setterModel" : {
"variableDeclarationType" : "DescribedUser",
"variableName" : "user",
"variableType" : "DescribedUser",
"documentation" : null,
"simpleType" : "DescribedUser",
"variableSetterType" : "DescribedUser"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "DescribedUser",
"variableName" : "user",
"variableType" : "DescribedUser",
"documentation" : "An array containing the properties of the user account for the ServerID value that you specified.
",
"simpleType" : "DescribedUser",
"variableSetterType" : "DescribedUser"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@return A system-assigned unique identifier for an SFTP server that has this user assigned.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
\n@param serverId A system-assigned unique identifier for an SFTP server that has this user assigned.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "A system-assigned unique identifier for an SFTP server that has this user assigned.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUser",
"beanStyleSetterMethodName" : "setUser",
"c2jName" : "User",
"c2jShape" : "DescribedUser",
"defaultConsumerFluentSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\nThis is a convenience that creates an instance of the {@link DescribedUser.Builder} avoiding the need to create one manually via {@link DescribedUser#builder()}.\n\nWhen the {@link Consumer} completes, {@link DescribedUser.Builder#build()} is called immediately and its result is passed to {@link #user(DescribedUser)}.\n@param user a consumer that will call methods on {@link DescribedUser.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #user(DescribedUser)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@return An array containing the properties of the user account for the ServerID value that you specified.\n@deprecated Use {@link #user()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #user(DescribedUser)}\n",
"documentation" : "An array containing the properties of the user account for the ServerID value that you specified.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the User property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUser",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "user",
"fluentSetterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "user",
"getterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@return An array containing the properties of the user account for the ServerID value that you specified.",
"getterModel" : {
"returnType" : "DescribedUser",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "User",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "User",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "User",
"sensitive" : false,
"setterDocumentation" : "An array containing the properties of the user account for the ServerID value that you specified.
\n@param user An array containing the properties of the user account for the ServerID value that you specified.",
"setterMethodName" : "setUser",
"setterModel" : {
"variableDeclarationType" : "DescribedUser",
"variableName" : "user",
"variableType" : "DescribedUser",
"documentation" : null,
"simpleType" : "DescribedUser",
"variableSetterType" : "DescribedUser"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "DescribedUser",
"variableName" : "user",
"variableType" : "DescribedUser",
"documentation" : "An array containing the properties of the user account for the ServerID value that you specified.
",
"simpleType" : "DescribedUser",
"variableSetterType" : "DescribedUser"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "ServerId", "User" ],
"shapeName" : "DescribeUserResponse",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DescribeUserResponse",
"variableName" : "describeUserResponse",
"variableType" : "DescribeUserResponse",
"documentation" : null,
"simpleType" : "DescribeUserResponse",
"variableSetterType" : "DescribeUserResponse"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribedServer" : {
"c2jName" : "DescribedServer",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getArn",
"beanStyleSetterMethodName" : "setArn",
"c2jName" : "Arn",
"c2jShape" : "Arn",
"defaultConsumerFluentSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\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 #arn(String)}.\n@param arn 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 #arn(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@return Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@deprecated Use {@link #arn()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #arn(String)}\n",
"documentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Arn property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasArn",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "arn",
"fluentSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "arn",
"getterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@return Specifies the unique Amazon Resource Name (ARN) for the server to be described.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Arn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Arn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Arn",
"sensitive" : false,
"setterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.",
"setterMethodName" : "setArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointDetails",
"beanStyleSetterMethodName" : "setEndpointDetails",
"c2jName" : "EndpointDetails",
"c2jShape" : "EndpointDetails",
"defaultConsumerFluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\nThis is a convenience that creates an instance of the {@link EndpointDetails.Builder} avoiding the need to create one manually via {@link EndpointDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link EndpointDetails.Builder#build()} is called immediately and its result is passed to {@link #endpointDetails(EndpointDetails)}.\n@param endpointDetails a consumer that will call methods on {@link EndpointDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #endpointDetails(EndpointDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@return The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@deprecated Use {@link #endpointDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #endpointDetails(EndpointDetails)}\n",
"documentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "endpointDetails",
"fluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "endpointDetails",
"getterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@return The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.",
"getterModel" : {
"returnType" : "EndpointDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "EndpointDetails",
"sensitive" : false,
"setterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.",
"setterMethodName" : "setEndpointDetails",
"setterModel" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : null,
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
",
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointTypeAsString",
"beanStyleSetterMethodName" : "setEndpointType",
"c2jName" : "EndpointType",
"c2jShape" : "EndpointType",
"defaultConsumerFluentSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\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 #endpointTypeAsString(String)}.\n@param endpointType 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 #endpointType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@deprecated Use {@link #endpointTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType\n@deprecated Use {@link #endpointType(String)}\n",
"documentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
"endpointDiscoveryId" : false,
"enumType" : "EndpointType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointType",
"fluentEnumGetterMethodName" : "endpointType",
"fluentEnumSetterMethodName" : "endpointType",
"fluentGetterMethodName" : "endpointTypeAsString",
"fluentSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType",
"fluentSetterMethodName" : "endpointType",
"getterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EndpointType",
"sensitive" : false,
"setterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType",
"setterMethodName" : "setEndpointType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHostKeyFingerprint",
"beanStyleSetterMethodName" : "setHostKeyFingerprint",
"c2jName" : "HostKeyFingerprint",
"c2jShape" : "HostKeyFingerprint",
"defaultConsumerFluentSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\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 #hostKeyFingerprint(String)}.\n@param hostKeyFingerprint 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 #hostKeyFingerprint(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@return This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@deprecated Use {@link #hostKeyFingerprint()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #hostKeyFingerprint(String)}\n",
"documentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HostKeyFingerprint property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHostKeyFingerprint",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "hostKeyFingerprint",
"fluentSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "hostKeyFingerprint",
"getterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@return This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HostKeyFingerprint",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HostKeyFingerprint",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HostKeyFingerprint",
"sensitive" : false,
"setterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.",
"setterMethodName" : "setHostKeyFingerprint",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "hostKeyFingerprint",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "hostKeyFingerprint",
"variableType" : "String",
"documentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderDetails",
"beanStyleSetterMethodName" : "setIdentityProviderDetails",
"c2jName" : "IdentityProviderDetails",
"c2jShape" : "IdentityProviderDetails",
"defaultConsumerFluentSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\nThis is a convenience that creates an instance of the {@link IdentityProviderDetails.Builder} avoiding the need to create one manually via {@link IdentityProviderDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link IdentityProviderDetails.Builder#build()} is called immediately and its result is passed to {@link #identityProviderDetails(IdentityProviderDetails)}.\n@param identityProviderDetails a consumer that will call methods on {@link IdentityProviderDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityProviderDetails(IdentityProviderDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@return Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@deprecated Use {@link #identityProviderDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #identityProviderDetails(IdentityProviderDetails)}\n",
"documentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityProviderDetails",
"fluentSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityProviderDetails",
"getterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@return Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.",
"getterModel" : {
"returnType" : "IdentityProviderDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "IdentityProviderDetails",
"sensitive" : false,
"setterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.",
"setterMethodName" : "setIdentityProviderDetails",
"setterModel" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : null,
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
",
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderTypeAsString",
"beanStyleSetterMethodName" : "setIdentityProviderType",
"c2jName" : "IdentityProviderType",
"c2jShape" : "IdentityProviderType",
"defaultConsumerFluentSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\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 #identityProviderTypeAsString(String)}.\n@param identityProviderType 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 #identityProviderType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderType(String)}\n",
"documentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
",
"endpointDiscoveryId" : false,
"enumType" : "IdentityProviderType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderType",
"fluentEnumGetterMethodName" : "identityProviderType",
"fluentEnumSetterMethodName" : "identityProviderType",
"fluentGetterMethodName" : "identityProviderTypeAsString",
"fluentSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType",
"fluentSetterMethodName" : "identityProviderType",
"getterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityProviderType",
"sensitive" : false,
"setterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType",
"setterMethodName" : "setIdentityProviderType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLoggingRole",
"beanStyleSetterMethodName" : "setLoggingRole",
"c2jName" : "LoggingRole",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\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 #loggingRole(String)}.\n@param loggingRole 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 #loggingRole(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@return This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@deprecated Use {@link #loggingRole()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #loggingRole(String)}\n",
"documentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the LoggingRole property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLoggingRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "loggingRole",
"fluentSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "loggingRole",
"getterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@return This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "LoggingRole",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "LoggingRole",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "LoggingRole",
"sensitive" : false,
"setterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.",
"setterMethodName" : "setLoggingRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@return This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@return This property is a unique system-assigned identifier for the SFTP server that you instantiate.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getStateAsString",
"beanStyleSetterMethodName" : "setState",
"c2jName" : "State",
"c2jShape" : "State",
"defaultConsumerFluentSetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\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 #stateAsString(String)}.\n@param state 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 #state(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #state} will return {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #stateAsString}.\n
\n@return The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@deprecated Use {@link #stateAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@return Returns a reference to this object so that method calls can be chained together.\n@see State\n@deprecated Use {@link #state(String)}\n",
"documentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
",
"endpointDiscoveryId" : false,
"enumType" : "State",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the State property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasState",
"fluentEnumGetterMethodName" : "state",
"fluentEnumSetterMethodName" : "state",
"fluentGetterMethodName" : "stateAsString",
"fluentSetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@return Returns a reference to this object so that method calls can be chained together.\n@see State",
"fluentSetterMethodName" : "state",
"getterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #state} will return {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #stateAsString}.\n
\n@return The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "State",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "State",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "State",
"sensitive" : false,
"setterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State",
"setterMethodName" : "setState",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "state",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "state",
"variableType" : "String",
"documentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserCount",
"beanStyleSetterMethodName" : "setUserCount",
"c2jName" : "UserCount",
"c2jShape" : "UserCount",
"defaultConsumerFluentSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #userCount(Integer)}.\n@param userCount a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #userCount(Integer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@return The number of users that are assigned to the SFTP server you specified with the ServerId.\n@deprecated Use {@link #userCount()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userCount(Integer)}\n",
"documentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserCount property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserCount",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userCount",
"fluentSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userCount",
"getterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@return The number of users that are assigned to the SFTP server you specified with the ServerId.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserCount",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserCount",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "UserCount",
"sensitive" : false,
"setterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.",
"setterMethodName" : "setUserCount",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "userCount",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "userCount",
"variableType" : "Integer",
"documentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"membersAsMap" : {
"Arn" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getArn",
"beanStyleSetterMethodName" : "setArn",
"c2jName" : "Arn",
"c2jShape" : "Arn",
"defaultConsumerFluentSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\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 #arn(String)}.\n@param arn 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 #arn(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@return Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@deprecated Use {@link #arn()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #arn(String)}\n",
"documentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Arn property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasArn",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "arn",
"fluentSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "arn",
"getterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@return Specifies the unique Amazon Resource Name (ARN) for the server to be described.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Arn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Arn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Arn",
"sensitive" : false,
"setterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.",
"setterMethodName" : "setArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"EndpointDetails" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointDetails",
"beanStyleSetterMethodName" : "setEndpointDetails",
"c2jName" : "EndpointDetails",
"c2jShape" : "EndpointDetails",
"defaultConsumerFluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\nThis is a convenience that creates an instance of the {@link EndpointDetails.Builder} avoiding the need to create one manually via {@link EndpointDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link EndpointDetails.Builder#build()} is called immediately and its result is passed to {@link #endpointDetails(EndpointDetails)}.\n@param endpointDetails a consumer that will call methods on {@link EndpointDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #endpointDetails(EndpointDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@return The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@deprecated Use {@link #endpointDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #endpointDetails(EndpointDetails)}\n",
"documentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "endpointDetails",
"fluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "endpointDetails",
"getterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@return The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.",
"getterModel" : {
"returnType" : "EndpointDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "EndpointDetails",
"sensitive" : false,
"setterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.",
"setterMethodName" : "setEndpointDetails",
"setterModel" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : null,
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
",
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"EndpointType" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointTypeAsString",
"beanStyleSetterMethodName" : "setEndpointType",
"c2jName" : "EndpointType",
"c2jShape" : "EndpointType",
"defaultConsumerFluentSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\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 #endpointTypeAsString(String)}.\n@param endpointType 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 #endpointType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@deprecated Use {@link #endpointTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType\n@deprecated Use {@link #endpointType(String)}\n",
"documentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
"endpointDiscoveryId" : false,
"enumType" : "EndpointType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointType",
"fluentEnumGetterMethodName" : "endpointType",
"fluentEnumSetterMethodName" : "endpointType",
"fluentGetterMethodName" : "endpointTypeAsString",
"fluentSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType",
"fluentSetterMethodName" : "endpointType",
"getterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EndpointType",
"sensitive" : false,
"setterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType",
"setterMethodName" : "setEndpointType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"HostKeyFingerprint" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHostKeyFingerprint",
"beanStyleSetterMethodName" : "setHostKeyFingerprint",
"c2jName" : "HostKeyFingerprint",
"c2jShape" : "HostKeyFingerprint",
"defaultConsumerFluentSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\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 #hostKeyFingerprint(String)}.\n@param hostKeyFingerprint 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 #hostKeyFingerprint(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@return This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@deprecated Use {@link #hostKeyFingerprint()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #hostKeyFingerprint(String)}\n",
"documentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HostKeyFingerprint property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHostKeyFingerprint",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "hostKeyFingerprint",
"fluentSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "hostKeyFingerprint",
"getterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@return This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HostKeyFingerprint",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HostKeyFingerprint",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HostKeyFingerprint",
"sensitive" : false,
"setterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.",
"setterMethodName" : "setHostKeyFingerprint",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "hostKeyFingerprint",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "hostKeyFingerprint",
"variableType" : "String",
"documentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"IdentityProviderDetails" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderDetails",
"beanStyleSetterMethodName" : "setIdentityProviderDetails",
"c2jName" : "IdentityProviderDetails",
"c2jShape" : "IdentityProviderDetails",
"defaultConsumerFluentSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\nThis is a convenience that creates an instance of the {@link IdentityProviderDetails.Builder} avoiding the need to create one manually via {@link IdentityProviderDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link IdentityProviderDetails.Builder#build()} is called immediately and its result is passed to {@link #identityProviderDetails(IdentityProviderDetails)}.\n@param identityProviderDetails a consumer that will call methods on {@link IdentityProviderDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityProviderDetails(IdentityProviderDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@return Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@deprecated Use {@link #identityProviderDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #identityProviderDetails(IdentityProviderDetails)}\n",
"documentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityProviderDetails",
"fluentSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityProviderDetails",
"getterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@return Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.",
"getterModel" : {
"returnType" : "IdentityProviderDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "IdentityProviderDetails",
"sensitive" : false,
"setterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.",
"setterMethodName" : "setIdentityProviderDetails",
"setterModel" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : null,
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
",
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"IdentityProviderType" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderTypeAsString",
"beanStyleSetterMethodName" : "setIdentityProviderType",
"c2jName" : "IdentityProviderType",
"c2jShape" : "IdentityProviderType",
"defaultConsumerFluentSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\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 #identityProviderTypeAsString(String)}.\n@param identityProviderType 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 #identityProviderType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderType(String)}\n",
"documentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
",
"endpointDiscoveryId" : false,
"enumType" : "IdentityProviderType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderType",
"fluentEnumGetterMethodName" : "identityProviderType",
"fluentEnumSetterMethodName" : "identityProviderType",
"fluentGetterMethodName" : "identityProviderTypeAsString",
"fluentSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType",
"fluentSetterMethodName" : "identityProviderType",
"getterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityProviderType",
"sensitive" : false,
"setterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType",
"setterMethodName" : "setIdentityProviderType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"LoggingRole" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLoggingRole",
"beanStyleSetterMethodName" : "setLoggingRole",
"c2jName" : "LoggingRole",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\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 #loggingRole(String)}.\n@param loggingRole 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 #loggingRole(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@return This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@deprecated Use {@link #loggingRole()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #loggingRole(String)}\n",
"documentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the LoggingRole property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLoggingRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "loggingRole",
"fluentSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "loggingRole",
"getterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@return This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "LoggingRole",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "LoggingRole",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "LoggingRole",
"sensitive" : false,
"setterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.",
"setterMethodName" : "setLoggingRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"ServerId" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@return This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@return This property is a unique system-assigned identifier for the SFTP server that you instantiate.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"State" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getStateAsString",
"beanStyleSetterMethodName" : "setState",
"c2jName" : "State",
"c2jShape" : "State",
"defaultConsumerFluentSetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\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 #stateAsString(String)}.\n@param state 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 #state(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #state} will return {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #stateAsString}.\n
\n@return The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@deprecated Use {@link #stateAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@return Returns a reference to this object so that method calls can be chained together.\n@see State\n@deprecated Use {@link #state(String)}\n",
"documentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
",
"endpointDiscoveryId" : false,
"enumType" : "State",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the State property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasState",
"fluentEnumGetterMethodName" : "state",
"fluentEnumSetterMethodName" : "state",
"fluentGetterMethodName" : "stateAsString",
"fluentSetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@return Returns a reference to this object so that method calls can be chained together.\n@see State",
"fluentSetterMethodName" : "state",
"getterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #state} will return {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #stateAsString}.\n
\n@return The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "State",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "State",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "State",
"sensitive" : false,
"setterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State",
"setterMethodName" : "setState",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "state",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "state",
"variableType" : "String",
"documentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"Tags" : {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"UserCount" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserCount",
"beanStyleSetterMethodName" : "setUserCount",
"c2jName" : "UserCount",
"c2jShape" : "UserCount",
"defaultConsumerFluentSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #userCount(Integer)}.\n@param userCount a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #userCount(Integer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@return The number of users that are assigned to the SFTP server you specified with the ServerId.\n@deprecated Use {@link #userCount()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userCount(Integer)}\n",
"documentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserCount property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserCount",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userCount",
"fluentSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userCount",
"getterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@return The number of users that are assigned to the SFTP server you specified with the ServerId.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserCount",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserCount",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "UserCount",
"sensitive" : false,
"setterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.",
"setterMethodName" : "setUserCount",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "userCount",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "userCount",
"variableType" : "Integer",
"documentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}
},
"nonStreamingMembers" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getArn",
"beanStyleSetterMethodName" : "setArn",
"c2jName" : "Arn",
"c2jShape" : "Arn",
"defaultConsumerFluentSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\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 #arn(String)}.\n@param arn 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 #arn(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@return Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@deprecated Use {@link #arn()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #arn(String)}\n",
"documentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Arn property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasArn",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "arn",
"fluentSetterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "arn",
"getterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@return Specifies the unique Amazon Resource Name (ARN) for the server to be described.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Arn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Arn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Arn",
"sensitive" : false,
"setterDocumentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
\n@param arn Specifies the unique Amazon Resource Name (ARN) for the server to be described.",
"setterMethodName" : "setArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : "Specifies the unique Amazon Resource Name (ARN) for the server to be described.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointDetails",
"beanStyleSetterMethodName" : "setEndpointDetails",
"c2jName" : "EndpointDetails",
"c2jShape" : "EndpointDetails",
"defaultConsumerFluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\nThis is a convenience that creates an instance of the {@link EndpointDetails.Builder} avoiding the need to create one manually via {@link EndpointDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link EndpointDetails.Builder#build()} is called immediately and its result is passed to {@link #endpointDetails(EndpointDetails)}.\n@param endpointDetails a consumer that will call methods on {@link EndpointDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #endpointDetails(EndpointDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@return The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@deprecated Use {@link #endpointDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #endpointDetails(EndpointDetails)}\n",
"documentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "endpointDetails",
"fluentSetterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "endpointDetails",
"getterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@return The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.",
"getterModel" : {
"returnType" : "EndpointDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "EndpointDetails",
"sensitive" : false,
"setterDocumentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
\n@param endpointDetails The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.",
"setterMethodName" : "setEndpointDetails",
"setterModel" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : null,
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "EndpointDetails",
"variableName" : "endpointDetails",
"variableType" : "EndpointDetails",
"documentation" : "The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.
",
"simpleType" : "EndpointDetails",
"variableSetterType" : "EndpointDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getEndpointTypeAsString",
"beanStyleSetterMethodName" : "setEndpointType",
"c2jName" : "EndpointType",
"c2jShape" : "EndpointType",
"defaultConsumerFluentSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\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 #endpointTypeAsString(String)}.\n@param endpointType 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 #endpointType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@deprecated Use {@link #endpointTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType\n@deprecated Use {@link #endpointType(String)}\n",
"documentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
"endpointDiscoveryId" : false,
"enumType" : "EndpointType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the EndpointType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasEndpointType",
"fluentEnumGetterMethodName" : "endpointType",
"fluentEnumSetterMethodName" : "endpointType",
"fluentGetterMethodName" : "endpointTypeAsString",
"fluentSetterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType\n@return Returns a reference to this object so that method calls can be chained together.\n@see EndpointType",
"fluentSetterMethodName" : "endpointType",
"getterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #endpointType} will return {@link EndpointType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #endpointTypeAsString}.\n
\n@return The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "EndpointType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "EndpointType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "EndpointType",
"sensitive" : false,
"setterDocumentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
\n@param endpointType The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.\n@see EndpointType",
"setterMethodName" : "setEndpointType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "endpointType",
"variableType" : "String",
"documentation" : "The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHostKeyFingerprint",
"beanStyleSetterMethodName" : "setHostKeyFingerprint",
"c2jName" : "HostKeyFingerprint",
"c2jShape" : "HostKeyFingerprint",
"defaultConsumerFluentSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\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 #hostKeyFingerprint(String)}.\n@param hostKeyFingerprint 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 #hostKeyFingerprint(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@return This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@deprecated Use {@link #hostKeyFingerprint()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #hostKeyFingerprint(String)}\n",
"documentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HostKeyFingerprint property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHostKeyFingerprint",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "hostKeyFingerprint",
"fluentSetterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "hostKeyFingerprint",
"getterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@return This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HostKeyFingerprint",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HostKeyFingerprint",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HostKeyFingerprint",
"sensitive" : false,
"setterDocumentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
\n@param hostKeyFingerprint This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.",
"setterMethodName" : "setHostKeyFingerprint",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "hostKeyFingerprint",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "hostKeyFingerprint",
"variableType" : "String",
"documentation" : "This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderDetails",
"beanStyleSetterMethodName" : "setIdentityProviderDetails",
"c2jName" : "IdentityProviderDetails",
"c2jShape" : "IdentityProviderDetails",
"defaultConsumerFluentSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\nThis is a convenience that creates an instance of the {@link IdentityProviderDetails.Builder} avoiding the need to create one manually via {@link IdentityProviderDetails#builder()}.\n\nWhen the {@link Consumer} completes, {@link IdentityProviderDetails.Builder#build()} is called immediately and its result is passed to {@link #identityProviderDetails(IdentityProviderDetails)}.\n@param identityProviderDetails a consumer that will call methods on {@link IdentityProviderDetails.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #identityProviderDetails(IdentityProviderDetails)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@return Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@deprecated Use {@link #identityProviderDetails()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #identityProviderDetails(IdentityProviderDetails)}\n",
"documentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderDetails property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderDetails",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "identityProviderDetails",
"fluentSetterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "identityProviderDetails",
"getterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@return Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.",
"getterModel" : {
"returnType" : "IdentityProviderDetails",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderDetails",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderDetails",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "IdentityProviderDetails",
"sensitive" : false,
"setterDocumentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
\n@param identityProviderDetails Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.",
"setterMethodName" : "setIdentityProviderDetails",
"setterModel" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : null,
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "IdentityProviderDetails",
"variableName" : "identityProviderDetails",
"variableType" : "IdentityProviderDetails",
"documentation" : "Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.
",
"simpleType" : "IdentityProviderDetails",
"variableSetterType" : "IdentityProviderDetails"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getIdentityProviderTypeAsString",
"beanStyleSetterMethodName" : "setIdentityProviderType",
"c2jName" : "IdentityProviderType",
"c2jShape" : "IdentityProviderType",
"defaultConsumerFluentSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\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 #identityProviderTypeAsString(String)}.\n@param identityProviderType 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 #identityProviderType(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderTypeAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType\n@deprecated Use {@link #identityProviderType(String)}\n",
"documentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
",
"endpointDiscoveryId" : false,
"enumType" : "IdentityProviderType",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the IdentityProviderType property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasIdentityProviderType",
"fluentEnumGetterMethodName" : "identityProviderType",
"fluentEnumSetterMethodName" : "identityProviderType",
"fluentGetterMethodName" : "identityProviderTypeAsString",
"fluentSetterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType\n@return Returns a reference to this object so that method calls can be chained together.\n@see IdentityProviderType",
"fluentSetterMethodName" : "identityProviderType",
"getterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #identityProviderType} will return {@link IdentityProviderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #identityProviderTypeAsString}.\n
\n@return This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "IdentityProviderType",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "IdentityProviderType",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "IdentityProviderType",
"sensitive" : false,
"setterDocumentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
\n@param identityProviderType This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.\n@see IdentityProviderType",
"setterMethodName" : "setIdentityProviderType",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "identityProviderType",
"variableType" : "String",
"documentation" : "This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getLoggingRole",
"beanStyleSetterMethodName" : "setLoggingRole",
"c2jName" : "LoggingRole",
"c2jShape" : "Role",
"defaultConsumerFluentSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\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 #loggingRole(String)}.\n@param loggingRole 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 #loggingRole(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@return This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@deprecated Use {@link #loggingRole()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #loggingRole(String)}\n",
"documentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the LoggingRole property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasLoggingRole",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "loggingRole",
"fluentSetterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "loggingRole",
"getterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@return This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "LoggingRole",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "LoggingRole",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "LoggingRole",
"sensitive" : false,
"setterDocumentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
\n@param loggingRole This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.",
"setterMethodName" : "setLoggingRole",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "loggingRole",
"variableType" : "String",
"documentation" : "This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getServerId",
"beanStyleSetterMethodName" : "setServerId",
"c2jName" : "ServerId",
"c2jShape" : "ServerId",
"defaultConsumerFluentSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\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 #serverId(String)}.\n@param serverId 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 #serverId(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@return This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@deprecated Use {@link #serverId()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #serverId(String)}\n",
"documentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the ServerId property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasServerId",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "serverId",
"fluentSetterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "serverId",
"getterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@return This property is a unique system-assigned identifier for the SFTP server that you instantiate.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "ServerId",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "ServerId",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "ServerId",
"sensitive" : false,
"setterDocumentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
\n@param serverId This property is a unique system-assigned identifier for the SFTP server that you instantiate.",
"setterMethodName" : "setServerId",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "serverId",
"variableType" : "String",
"documentation" : "This property is a unique system-assigned identifier for the SFTP server that you instantiate.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getStateAsString",
"beanStyleSetterMethodName" : "setState",
"c2jName" : "State",
"c2jShape" : "State",
"defaultConsumerFluentSetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\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 #stateAsString(String)}.\n@param state 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 #state(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #state} will return {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #stateAsString}.\n
\n@return The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@deprecated Use {@link #stateAsString()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@return Returns a reference to this object so that method calls can be chained together.\n@see State\n@deprecated Use {@link #state(String)}\n",
"documentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
",
"endpointDiscoveryId" : false,
"enumType" : "State",
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the State property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasState",
"fluentEnumGetterMethodName" : "state",
"fluentEnumSetterMethodName" : "state",
"fluentGetterMethodName" : "stateAsString",
"fluentSetterDocumentation" : "The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State\n@return Returns a reference to this object so that method calls can be chained together.\n@see State",
"fluentSetterMethodName" : "state",
"getterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n\nIf the service returns an enum value that is not available in the current SDK version, {@link #state} will return {@link State#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from {@link #stateAsString}.\n
\n@return The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "State",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "State",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "State",
"sensitive" : false,
"setterDocumentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
\n@param state The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations. The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.\n@see State",
"setterMethodName" : "setState",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "state",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "state",
"variableType" : "String",
"documentation" : "
The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getTags",
"beanStyleSetterMethodName" : "setTags",
"c2jName" : "Tags",
"c2jShape" : "Tags",
"defaultConsumerFluentSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #tags(List)}.\n@param tags a consumer that will call methods on {@link List.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #tags(List)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@deprecated Use {@link #tags()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #tags(List)}\n",
"documentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasTags",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "tags",
"fluentSetterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "tags",
"getterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n\nAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.\n
\n\nYou can use {@link #hasTags()} to see if a value was sent in this field.\n
\n@return This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.",
"getterModel" : {
"returnType" : "java.util.List",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Tags",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Tags",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : true,
"listModel" : {
"implType" : "java.util.ArrayList",
"interfaceType" : "java.util.List",
"listMemberModel" : {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getMember",
"beanStyleSetterMethodName" : "setMember",
"c2jName" : "member",
"c2jShape" : "Tag",
"defaultConsumerFluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\nThis is a convenience that creates an instance of the {@link Tag.Builder} avoiding the need to create one manually via {@link Tag#builder()}.\n\nWhen the {@link Consumer} completes, {@link Tag.Builder#build()} is called immediately and its result is passed to {@link #member(Tag)}.\n@param member a consumer that will call methods on {@link Tag.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #member(Tag)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.\n@deprecated Use {@link #member()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #member(Tag)}\n",
"documentation" : "",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Member property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasMember",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "member",
"fluentSetterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "member",
"getterDocumentation" : "Returns the value of the Member property for this object.\n@return The value of the Member property for this object.",
"getterModel" : {
"returnType" : "Tag",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "member",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "member",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "SDK_POJO",
"name" : "Member",
"sensitive" : false,
"setterDocumentation" : "Sets the value of the Member property for this object.\n\n@param member The new value for the Member property for this object.",
"setterMethodName" : "setMember",
"setterModel" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : null,
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Tag",
"variableName" : "member",
"variableType" : "Tag",
"documentation" : "",
"simpleType" : "Tag",
"variableSetterType" : "Tag"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
},
"memberLocationName" : null,
"memberType" : "Tag",
"map" : false,
"memberAdditionalMarshallingPath" : null,
"memberAdditionalUnmarshallingPath" : null,
"simple" : false,
"simpleType" : "Tag",
"templateImplType" : "java.util.ArrayList",
"templateType" : "java.util.List"
},
"map" : false,
"mapModel" : null,
"marshallingType" : "LIST",
"name" : "Tags",
"sensitive" : false,
"setterDocumentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
\n@param tags This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.",
"setterMethodName" : "setTags",
"setterModel" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : null,
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"simple" : false,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "java.util.List",
"variableName" : "tags",
"variableType" : "java.util.List",
"documentation" : "This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
",
"simpleType" : "List",
"variableSetterType" : "java.util.Collection"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getUserCount",
"beanStyleSetterMethodName" : "setUserCount",
"c2jName" : "UserCount",
"c2jShape" : "UserCount",
"defaultConsumerFluentSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\nThis is a convenience that creates an instance of the {@link Integer.Builder} avoiding the need to create one manually via {@link Integer#builder()}.\n\nWhen the {@link Consumer} completes, {@link Integer.Builder#build()} is called immediately and its result is passed to {@link #userCount(Integer)}.\n@param userCount a consumer that will call methods on {@link Integer.Builder}\n@return Returns a reference to this object so that method calls can be chained together.\n@see #userCount(Integer)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@return The number of users that are assigned to the SFTP server you specified with the ServerId.\n@deprecated Use {@link #userCount()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #userCount(Integer)}\n",
"documentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the UserCount property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasUserCount",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "userCount",
"fluentSetterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "userCount",
"getterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@return The number of users that are assigned to the SFTP server you specified with the ServerId.",
"getterModel" : {
"returnType" : "Integer",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "UserCount",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "UserCount",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "INTEGER",
"name" : "UserCount",
"sensitive" : false,
"setterDocumentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
\n@param userCount The number of users that are assigned to the SFTP server you specified with the ServerId.",
"setterMethodName" : "setUserCount",
"setterModel" : {
"variableDeclarationType" : "Integer",
"variableName" : "userCount",
"variableType" : "Integer",
"documentation" : null,
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "Integer",
"variableName" : "userCount",
"variableType" : "Integer",
"documentation" : "The number of users that are assigned to the SFTP server you specified with the ServerId.
",
"simpleType" : "Integer",
"variableSetterType" : "Integer"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
} ],
"requestSignerAware" : false,
"requestSignerClassFqcn" : null,
"required" : [ "Arn" ],
"shapeName" : "DescribedServer",
"simpleMethod" : false,
"unmarshaller" : {
"flattened" : false,
"resultWrapper" : null
},
"variable" : {
"variableDeclarationType" : "DescribedServer",
"variableName" : "describedServer",
"variableType" : "DescribedServer",
"documentation" : null,
"simpleType" : "DescribedServer",
"variableSetterType" : "DescribedServer"
},
"wrapper" : false,
"xmlNamespace" : null
},
"DescribedUser" : {
"c2jName" : "DescribedUser",
"customization" : {
"artificialResultWrapper" : null,
"skipGeneratingMarshaller" : false,
"skipGeneratingModelClass" : false,
"skipGeneratingUnmarshaller" : false,
"staxTargetDepthOffset" : 0
},
"deprecated" : false,
"documentation" : "Returns properties of the user that you want to describe.
",
"endpointDiscovery" : null,
"enums" : null,
"errorCode" : null,
"event" : false,
"eventStream" : false,
"explicitEventPayloadMember" : null,
"hasHeaderMember" : false,
"hasPayloadMember" : false,
"hasRequiresLengthMember" : false,
"hasStatusCodeMember" : false,
"hasStreamingMember" : false,
"httpStatusCode" : null,
"marshaller" : null,
"members" : [ {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getArn",
"beanStyleSetterMethodName" : "setArn",
"c2jName" : "Arn",
"c2jShape" : "Arn",
"defaultConsumerFluentSetterDocumentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
\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 #arn(String)}.\n@param arn 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 #arn(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
\n@return This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.\n@deprecated Use {@link #arn()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
\n@param arn This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #arn(String)}\n",
"documentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the Arn property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasArn",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "arn",
"fluentSetterDocumentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
\n@param arn This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "arn",
"getterDocumentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
\n@return This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "Arn",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "Arn",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "Arn",
"sensitive" : false,
"setterDocumentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
\n@param arn This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.",
"setterMethodName" : "setArn",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "arn",
"variableType" : "String",
"documentation" : "This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : false
},
"beanStyleGetterMethodName" : "getHomeDirectory",
"beanStyleSetterMethodName" : "setHomeDirectory",
"c2jName" : "HomeDirectory",
"c2jShape" : "HomeDirectory",
"defaultConsumerFluentSetterDocumentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
\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 #homeDirectory(String)}.\n@param homeDirectory 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 #homeDirectory(String)",
"deprecated" : false,
"deprecatedBeanStyleSetterMethodName" : null,
"deprecatedFluentGetterMethodName" : null,
"deprecatedFluentSetterMethodName" : null,
"deprecatedGetterDocumentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
\n@return This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .\n@deprecated Use {@link #homeDirectory()}\n",
"deprecatedName" : null,
"deprecatedSetterDocumentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
\n@param homeDirectory This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .\n@return Returns a reference to this object so that method calls can be chained together.\n@deprecated Use {@link #homeDirectory(String)}\n",
"documentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
",
"endpointDiscoveryId" : false,
"enumType" : null,
"eventHeader" : false,
"eventPayload" : false,
"existenceCheckDocumentation" : "Returns true if the HomeDirectory property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.\n",
"existenceCheckMethodName" : "hasHomeDirectory",
"fluentEnumGetterMethodName" : null,
"fluentEnumSetterMethodName" : null,
"fluentGetterMethodName" : "homeDirectory",
"fluentSetterDocumentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
\n@param homeDirectory This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .\n@return Returns a reference to this object so that method calls can be chained together.",
"fluentSetterMethodName" : "homeDirectory",
"getterDocumentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
\n@return This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .",
"getterModel" : {
"returnType" : "String",
"documentation" : null
},
"http" : {
"additionalMarshallingPath" : null,
"additionalUnmarshallingPath" : null,
"flattened" : false,
"greedy" : false,
"header" : false,
"isPayload" : false,
"isStreaming" : false,
"location" : null,
"marshallLocation" : "PAYLOAD",
"marshallLocationName" : "HomeDirectory",
"queryString" : false,
"requiresLength" : false,
"statusCode" : false,
"unmarshallLocationName" : "HomeDirectory",
"uri" : false
},
"idempotencyToken" : false,
"isBinary" : false,
"jsonValue" : false,
"list" : false,
"listModel" : null,
"map" : false,
"mapModel" : null,
"marshallingType" : "STRING",
"name" : "HomeDirectory",
"sensitive" : false,
"setterDocumentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
\n@param homeDirectory This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .",
"setterMethodName" : "setHomeDirectory",
"setterModel" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : null,
"simpleType" : "String",
"variableSetterType" : "String"
},
"simple" : true,
"timestampFormat" : null,
"variable" : {
"variableDeclarationType" : "String",
"variableName" : "homeDirectory",
"variableType" : "String",
"documentation" : "This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .
",
"simpleType" : "String",
"variableSetterType" : "String"
},
"xmlAttribute" : false,
"xmlNameSpaceUri" : null
}, {
"autoConstructClassIfExists" : {
"present" : true
},
"beanStyleGetterMethodName" : "getHomeDirectoryMappings",
"beanStyleSetterMethodName" : "setHomeDirectoryMappings",
"c2jName" : "HomeDirectoryMappings",
"c2jShape" : "HomeDirectoryMappings",
"defaultConsumerFluentSetterDocumentation" : "Logical directory mappings that you specified for what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target.
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.
\nThis is a convenience that creates an instance of the {@link List.Builder} avoiding the need to create one manually via {@link List#builder()}.\n\nWhen the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its result is passed to {@link #homeDirectoryMappings(List