com.amazonaws

Class AmazonWebServiceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

Direct Known Subclasses:

AbortMultipartUploadRequest, AcceptVpcPeeringConnectionRequest, AddPermissionRequest, AddPermissionRequest, AddTagsToStreamRequest, AllocateAddressRequest, ApplySecurityGroupsToLoadBalancerRequest, AssignPrivateIpAddressesRequest, AssociateAddressRequest, AssociateDhcpOptionsRequest, AssociateRouteTableRequest, AssumeRoleRequest, AssumeRoleWithSAMLRequest, AssumeRoleWithWebIdentityRequest, AttachInstancesRequest, AttachInternetGatewayRequest, AttachLoadBalancerToSubnetsRequest, AttachNetworkInterfaceRequest, AttachVolumeRequest, AttachVpnGatewayRequest, AuthorizeSecurityGroupEgressRequest, AuthorizeSecurityGroupIngressRequest, BatchDeleteAttributesRequest, BatchGetItemRequest, BatchPutAttributesRequest, BatchWriteItemRequest, BundleInstanceRequest, CancelBundleTaskRequest, CancelConversionTaskRequest, CancelExportTaskRequest, CancelReservedInstancesListingRequest, CancelSpotInstanceRequestsRequest, ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityRequest, CompleteMultipartUploadRequest, ConfigureHealthCheckRequest, ConfirmProductInstanceRequest, ConfirmSubscriptionRequest, CopyImageRequest, CopyObjectRequest, CopyPartRequest, CopySnapshotRequest, CreateAppCookieStickinessPolicyRequest, CreateAutoScalingGroupRequest, CreateBucketRequest, CreateCustomerGatewayRequest, CreateDhcpOptionsRequest, CreateDomainRequest, CreateIdentityPoolRequest, CreateImageRequest, CreateInstanceExportTaskRequest, CreateInternetGatewayRequest, CreateKeyPairRequest, CreateLaunchConfigurationRequest, CreateLBCookieStickinessPolicyRequest, CreateLoadBalancerListenersRequest, CreateLoadBalancerPolicyRequest, CreateLoadBalancerRequest, CreateNetworkAclEntryRequest, CreateNetworkAclRequest, CreateNetworkInterfaceRequest, CreateOrUpdateTagsRequest, CreatePlacementGroupRequest, CreatePlatformApplicationRequest, CreatePlatformEndpointRequest, CreateQueueRequest, CreateReservedInstancesListingRequest, CreateRouteRequest, CreateRouteTableRequest, CreateSecurityGroupRequest, CreateSnapshotRequest, CreateSpotDatafeedSubscriptionRequest, CreateStreamRequest, CreateSubnetRequest, CreateTableRequest, CreateTagsRequest, CreateTopicRequest, CreateVolumeRequest, CreateVpcPeeringConnectionRequest, CreateVpcRequest, CreateVpnConnectionRequest, CreateVpnConnectionRouteRequest, CreateVpnGatewayRequest, DecodeAuthorizationMessageRequest, DeleteAlarmsRequest, DeleteAttributesRequest, DeleteAutoScalingGroupRequest, DeleteBucketPolicyRequest, DeleteBucketRequest, DeleteCustomerGatewayRequest, DeleteDatasetRequest, DeleteDhcpOptionsRequest, DeleteDomainRequest, DeleteEndpointRequest, DeleteIdentityPoolRequest, DeleteIdentityRequest, DeleteInternetGatewayRequest, DeleteItemRequest, DeleteKeyPairRequest, DeleteLaunchConfigurationRequest, DeleteLoadBalancerListenersRequest, DeleteLoadBalancerPolicyRequest, DeleteLoadBalancerRequest, DeleteMessageBatchRequest, DeleteMessageRequest, DeleteNetworkAclEntryRequest, DeleteNetworkAclRequest, DeleteNetworkInterfaceRequest, DeleteNotificationConfigurationRequest, DeleteObjectRequest, DeleteObjectsRequest, DeletePlacementGroupRequest, DeletePlatformApplicationRequest, DeletePolicyRequest, DeleteQueueRequest, DeleteRouteRequest, DeleteRouteTableRequest, DeleteScheduledActionRequest, DeleteSecurityGroupRequest, DeleteSnapshotRequest, DeleteSpotDatafeedSubscriptionRequest, DeleteStreamRequest, DeleteSubnetRequest, DeleteTableRequest, DeleteTagsRequest, DeleteTagsRequest, DeleteTopicRequest, DeleteVerifiedEmailAddressRequest, DeleteVersionRequest, DeleteVolumeRequest, DeleteVpcPeeringConnectionRequest, DeleteVpcRequest, DeleteVpnConnectionRequest, DeleteVpnConnectionRouteRequest, DeleteVpnGatewayRequest, DeregisterImageRequest, DeregisterInstancesFromLoadBalancerRequest, DescribeAccountAttributesRequest, DescribeAccountLimitsRequest, DescribeAddressesRequest, DescribeAdjustmentTypesRequest, DescribeAlarmHistoryRequest, DescribeAlarmsForMetricRequest, DescribeAlarmsRequest, DescribeAutoScalingGroupsRequest, DescribeAutoScalingInstancesRequest, DescribeAutoScalingNotificationTypesRequest, DescribeAvailabilityZonesRequest, DescribeBundleTasksRequest, DescribeConversionTasksRequest, DescribeCustomerGatewaysRequest, DescribeDatasetRequest, DescribeDhcpOptionsRequest, DescribeExportTasksRequest, DescribeIdentityPoolRequest, DescribeIdentityPoolUsageRequest, DescribeIdentityRequest, DescribeIdentityUsageRequest, DescribeImageAttributeRequest, DescribeImagesRequest, DescribeInstanceAttributeRequest, DescribeInstanceHealthRequest, DescribeInstancesRequest, DescribeInstanceStatusRequest, DescribeInternetGatewaysRequest, DescribeKeyPairsRequest, DescribeLaunchConfigurationsRequest, DescribeLoadBalancerAttributesRequest, DescribeLoadBalancerPoliciesRequest, DescribeLoadBalancerPolicyTypesRequest, DescribeLoadBalancersRequest, DescribeMetricCollectionTypesRequest, DescribeNetworkAclsRequest, DescribeNetworkInterfaceAttributeRequest, DescribeNetworkInterfacesRequest, DescribeNotificationConfigurationsRequest, DescribePlacementGroupsRequest, DescribePoliciesRequest, DescribeRegionsRequest, DescribeReservedInstancesListingsRequest, DescribeReservedInstancesModificationsRequest, DescribeReservedInstancesOfferingsRequest, DescribeReservedInstancesRequest, DescribeRouteTablesRequest, DescribeScalingActivitiesRequest, DescribeScalingProcessTypesRequest, DescribeScheduledActionsRequest, DescribeSecurityGroupsRequest, DescribeSnapshotAttributeRequest, DescribeSnapshotsRequest, DescribeSpotDatafeedSubscriptionRequest, DescribeSpotInstanceRequestsRequest, DescribeSpotPriceHistoryRequest, DescribeStreamRequest, DescribeSubnetsRequest, DescribeTableRequest, DescribeTagsRequest, DescribeTagsRequest, DescribeTerminationPolicyTypesRequest, DescribeVolumeAttributeRequest, DescribeVolumesRequest, DescribeVolumeStatusRequest, DescribeVpcAttributeRequest, DescribeVpcPeeringConnectionsRequest, DescribeVpcsRequest, DescribeVpnConnectionsRequest, DescribeVpnGatewaysRequest, DetachInternetGatewayRequest, DetachLoadBalancerFromSubnetsRequest, DetachNetworkInterfaceRequest, DetachVolumeRequest, DetachVpnGatewayRequest, DisableAlarmActionsRequest, DisableAvailabilityZonesForLoadBalancerRequest, DisableMetricsCollectionRequest, DisableVgwRoutePropagationRequest, DisassociateAddressRequest, DisassociateRouteTableRequest, DomainMetadataRequest, EnableAlarmActionsRequest, EnableAvailabilityZonesForLoadBalancerRequest, EnableMetricsCollectionRequest, EnableVgwRoutePropagationRequest, EnableVolumeIORequest, ExecutePolicyRequest, GeneratePresignedUrlRequest, GenericBucketRequest, GetAttributesRequest, GetBucketAclRequest, GetBucketLocationRequest, GetBucketPolicyRequest, GetBucketWebsiteConfigurationRequest, GetConsoleOutputRequest, GetCredentialsForIdentityRequest, GetEndpointAttributesRequest, GetFederationTokenRequest, GetIdentityDkimAttributesRequest, GetIdentityNotificationAttributesRequest, GetIdentityPoolConfigurationRequest, GetIdentityPoolRolesRequest, GetIdentityVerificationAttributesRequest, GetIdRequest, GetItemRequest, GetMetricStatisticsRequest, GetObjectMetadataRequest, GetObjectRequest, GetOpenIdTokenForDeveloperIdentityRequest, GetOpenIdTokenRequest, GetPasswordDataRequest, GetPlatformApplicationAttributesRequest, GetQueueAttributesRequest, GetQueueUrlRequest, GetRecordsRequest, GetRequestPaymentConfigurationRequest, GetSendQuotaRequest, GetSendStatisticsRequest, GetSessionTokenRequest, GetShardIteratorRequest, GetSubscriptionAttributesRequest, GetTopicAttributesRequest, HeadBucketRequest, ImportInstanceRequest, ImportKeyPairRequest, ImportVolumeRequest, InitiateMultipartUploadRequest, ListBucketsRequest, ListDatasetsRequest, ListDeadLetterSourceQueuesRequest, ListDomainsRequest, ListEndpointsByPlatformApplicationRequest, ListIdentitiesRequest, ListIdentitiesRequest, ListIdentityPoolsRequest, ListIdentityPoolUsageRequest, ListMetricsRequest, ListMultipartUploadsRequest, ListObjectsRequest, ListPartsRequest, ListPlatformApplicationsRequest, ListQueuesRequest, ListRecordsRequest, ListStreamsRequest, ListSubscriptionsByTopicRequest, ListSubscriptionsRequest, ListTablesRequest, ListTagsForStreamRequest, ListTopicsRequest, ListVerifiedEmailAddressesRequest, ListVersionsRequest, LookupDeveloperIdentityRequest, MergeDeveloperIdentitiesRequest, MergeShardsRequest, ModifyImageAttributeRequest, ModifyInstanceAttributeRequest, ModifyLoadBalancerAttributesRequest, ModifyNetworkInterfaceAttributeRequest, ModifyReservedInstancesRequest, ModifySnapshotAttributeRequest, ModifyVolumeAttributeRequest, ModifyVpcAttributeRequest, MonitorInstancesRequest, PublishRequest, PurchaseReservedInstancesOfferingRequest, PutAttributesRequest, PutEventsRequest, PutItemRequest, PutMetricAlarmRequest, PutMetricDataRequest, PutNotificationConfigurationRequest, PutObjectRequest, PutRecordRequest, PutRecordsRequest, PutScalingPolicyRequest, PutScheduledUpdateGroupActionRequest, QueryRequest, RebootInstancesRequest, ReceiveMessageRequest, RegisterDeviceRequest, RegisterImageRequest, RegisterInstancesWithLoadBalancerRequest, RejectVpcPeeringConnectionRequest, ReleaseAddressRequest, RemovePermissionRequest, RemovePermissionRequest, RemoveTagsFromStreamRequest, ReplaceNetworkAclAssociationRequest, ReplaceNetworkAclEntryRequest, ReplaceRouteRequest, ReplaceRouteTableAssociationRequest, ReportInstanceStatusRequest, RequestSpotInstancesRequest, ResetImageAttributeRequest, ResetInstanceAttributeRequest, ResetNetworkInterfaceAttributeRequest, ResetSnapshotAttributeRequest, ResponseHeaderOverrides, RestoreObjectRequest, ResumeProcessesRequest, RevokeSecurityGroupEgressRequest, RevokeSecurityGroupIngressRequest, RunInstancesRequest, ScanRequest, SelectRequest, SendEmailRequest, SendMessageBatchRequest, SendMessageRequest, SendRawEmailRequest, SetAlarmStateRequest, SetBucketAclRequest, SetBucketCrossOriginConfigurationRequest, SetBucketLifecycleConfigurationRequest, SetBucketLoggingConfigurationRequest, SetBucketNotificationConfigurationRequest, SetBucketPolicyRequest, SetBucketTaggingConfigurationRequest, SetBucketVersioningConfigurationRequest, SetBucketWebsiteConfigurationRequest, SetDesiredCapacityRequest, SetEndpointAttributesRequest, SetIdentityDkimEnabledRequest, SetIdentityFeedbackForwardingEnabledRequest, SetIdentityNotificationTopicRequest, SetIdentityPoolConfigurationRequest, SetIdentityPoolRolesRequest, SetInstanceHealthRequest, SetLoadBalancerListenerSSLCertificateRequest, SetLoadBalancerPoliciesForBackendServerRequest, SetLoadBalancerPoliciesOfListenerRequest, SetPlatformApplicationAttributesRequest, SetQueueAttributesRequest, SetRequestPaymentConfigurationRequest, SetSubscriptionAttributesRequest, SetTopicAttributesRequest, SplitShardRequest, StartInstancesRequest, StopInstancesRequest, SubscribeRequest, SubscribeToDatasetRequest, SuspendProcessesRequest, TerminateInstanceInAutoScalingGroupRequest, TerminateInstancesRequest, UnassignPrivateIpAddressesRequest, UnlinkDeveloperIdentityRequest, UnlinkIdentityRequest, UnmonitorInstancesRequest, UnsubscribeFromDatasetRequest, UnsubscribeRequest, UpdateAutoScalingGroupRequest, UpdateIdentityPoolRequest, UpdateItemRequest, UpdateRecordsRequest, UpdateTableRequest, UploadPartRequest, VerifyDomainDkimRequest, VerifyDomainIdentityRequest, VerifyEmailAddressRequest, VerifyEmailIdentityRequest

@NotThreadSafe
public abstract class AmazonWebServiceRequest
extends java.lang.Object

Base class for all user facing web service requests.

Constructor Summary

Constructors

Constructor and Description
AmazonWebServiceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	copyPrivateRequestParameters() Internal only method for accessing private, internal request parameters.
java.lang.String	getDelegationToken() Deprecated. Pass a AWSSessionCredentials to your client constructor instead. Note the delegationToken methods do not work for services other than s3.
RequestClientOptions	getRequestClientOptions() Gets the options stored with this request object.
AWSCredentials	getRequestCredentials() Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.
RequestMetricCollector	getRequestMetricCollector() Returns a request level metric collector; or null if not specified.
void	setDelegationToken(java.lang.String delegationToken) Deprecated. Pass a AWSSessionCredentials to your client constructor instead. Note the delegationToken methods do not work for services other than s3.
void	setRequestCredentials(AWSCredentials credentials) Sets the optional credentials to use for this request, overriding the default credentials set at the client level.
void	setRequestMetricCollector(RequestMetricCollector requestMetricCollector) Sets a request level request metric collector which takes precedence over the ones at the http client level and AWS SDK level.
<T extends AmazonWebServiceRequest> T	withRequestMetricCollector(RequestMetricCollector metricCollector) Specifies a request level metric collector which takes precedence over the ones at the http client level and AWS SDK level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AmazonWebServiceRequest

public AmazonWebServiceRequest()

Method Detail

getDelegationToken

@Deprecated
public java.lang.String getDelegationToken()

Deprecated. Pass a AWSSessionCredentials to your client constructor instead. Note the delegationToken methods do not work for services other than s3.

Returns the optional STS security token associated with the request. This method is not available in the external release of the SDK.

Returns:

the optional STS security token associated with the request.

setDelegationToken

@Deprecated
public void setDelegationToken(java.lang.String delegationToken)

Deprecated. Pass a AWSSessionCredentials to your client constructor instead. Note the delegationToken methods do not work for services other than s3.

Sets the optional STS security token associated with the request. This method is not available in the external release of the SDK.

Parameters:

delegationToken - The optional STS security token associated with the request.

setRequestCredentials

public void setRequestCredentials(AWSCredentials credentials)

Sets the optional credentials to use for this request, overriding the default credentials set at the client level.

Parameters:

credentials - The optional AWS security credentials to use for this request, overriding the default credentials set at the client level.

getRequestCredentials

public AWSCredentials getRequestCredentials()

Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.

Returns:

The optional credentials to use to sign this request, overriding the default credentials set at the client level.

copyPrivateRequestParameters

public java.util.Map<java.lang.String,java.lang.String> copyPrivateRequestParameters()

Internal only method for accessing private, internal request parameters. Not intended for direct use by callers.

Returns:

private, internal request parameter information.

getRequestClientOptions

public RequestClientOptions getRequestClientOptions()

Gets the options stored with this request object. Intended for internal use only.

getRequestMetricCollector

public RequestMetricCollector getRequestMetricCollector()

Returns a request level metric collector; or null if not specified.

setRequestMetricCollector

public void setRequestMetricCollector(RequestMetricCollector requestMetricCollector)

Sets a request level request metric collector which takes precedence over the ones at the http client level and AWS SDK level.

withRequestMetricCollector

public <T extends AmazonWebServiceRequest> T withRequestMetricCollector(RequestMetricCollector metricCollector)

Specifies a request level metric collector which takes precedence over the ones at the http client level and AWS SDK level.