/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace S3Control { namespace Model { /** */ class GetAccessPointRequest : public S3ControlRequest { public: AWS_S3CONTROL_API GetAccessPointRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetAccessPoint"; } AWS_S3CONTROL_API Aws::String SerializePayload() const override; AWS_S3CONTROL_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3CONTROL_API EndpointParameters GetEndpointContextParams() const override; /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline const Aws::String& GetAccountId() const{ return m_accountId; } /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline bool AccountIdHasBeenSet() const { return m_accountIdHasBeenSet; } /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline void SetAccountId(const Aws::String& value) { m_accountIdHasBeenSet = true; m_accountId = value; } /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline void SetAccountId(Aws::String&& value) { m_accountIdHasBeenSet = true; m_accountId = std::move(value); } /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline void SetAccountId(const char* value) { m_accountIdHasBeenSet = true; m_accountId.assign(value); } /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline GetAccessPointRequest& WithAccountId(const Aws::String& value) { SetAccountId(value); return *this;} /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline GetAccessPointRequest& WithAccountId(Aws::String&& value) { SetAccountId(std::move(value)); return *this;} /** *

The Amazon Web Services account ID for the account that owns the specified * access point.

*/ inline GetAccessPointRequest& WithAccountId(const char* value) { SetAccountId(value); return *this;} /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline GetAccessPointRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline GetAccessPointRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

The name of the access point whose configuration information you want to * retrieve.

For using this parameter with Amazon S3 on Outposts with the * REST API, you must specify the name and the x-amz-outpost-id as well.

For * using this parameter with S3 on Outposts with the Amazon Web Services SDK and * CLI, you must specify the ARN of the access point accessed in the format * arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name>. * For example, to access the access point reports-ap through Outpost * my-outpost owned by account 123456789012 in Region * us-west-2, use the URL encoding of * arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap. * The value must be URL encoded.

*/ inline GetAccessPointRequest& WithName(const char* value) { SetName(value); return *this;} private: Aws::String m_accountId; bool m_accountIdHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; }; } // namespace Model } // namespace S3Control } // namespace Aws