- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetApplicationCommand
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MigrationHubRefactorSpacesClient, GetApplicationCommand } from "@aws-sdk/client-migration-hub-refactor-spaces"; // ES Modules import
// const { MigrationHubRefactorSpacesClient, GetApplicationCommand } = require("@aws-sdk/client-migration-hub-refactor-spaces"); // CommonJS import
const client = new MigrationHubRefactorSpacesClient(config);
const input = { // GetApplicationRequest
EnvironmentIdentifier: "STRING_VALUE", // required
ApplicationIdentifier: "STRING_VALUE", // required
};
const command = new GetApplicationCommand(input);
const response = await client.send(command);
// { // GetApplicationResponse
// Name: "STRING_VALUE",
// Arn: "STRING_VALUE",
// OwnerAccountId: "STRING_VALUE",
// CreatedByAccountId: "STRING_VALUE",
// ApplicationId: "STRING_VALUE",
// EnvironmentId: "STRING_VALUE",
// VpcId: "STRING_VALUE",
// ProxyType: "STRING_VALUE",
// ApiGatewayProxy: { // ApiGatewayProxyConfig
// ProxyUrl: "STRING_VALUE",
// ApiGatewayId: "STRING_VALUE",
// VpcLinkId: "STRING_VALUE",
// NlbArn: "STRING_VALUE",
// NlbName: "STRING_VALUE",
// EndpointType: "STRING_VALUE",
// StageName: "STRING_VALUE",
// },
// State: "STRING_VALUE",
// Tags: { // TagMap
// "<keys>": "STRING_VALUE",
// },
// Error: { // ErrorResponse
// Code: "STRING_VALUE",
// Message: "STRING_VALUE",
// AccountId: "STRING_VALUE",
// ResourceIdentifier: "STRING_VALUE",
// ResourceType: "STRING_VALUE",
// AdditionalDetails: { // AdditionalDetails
// "<keys>": "STRING_VALUE",
// },
// },
// LastUpdatedTime: new Date("TIMESTAMP"),
// CreatedTime: new Date("TIMESTAMP"),
// };
GetApplicationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ApplicationIdentifier Required | string | undefined | The ID of the application. |
EnvironmentIdentifier Required | string | undefined | The ID of the environment. |
GetApplicationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ApiGatewayProxy | ApiGatewayProxyConfig | undefined | The endpoint URL of the API Gateway proxy. |
ApplicationId | string | undefined | The unique identifier of the application. |
Arn | string | undefined | The Amazon Resource Name (ARN) of the application. |
CreatedByAccountId | string | undefined | The Amazon Web Services account ID of the application creator. |
CreatedTime | Date | undefined | A timestamp that indicates when the application is created. |
EnvironmentId | string | undefined | The unique identifier of the environment. |
Error | ErrorResponse | undefined | Any error associated with the application resource. |
LastUpdatedTime | Date | undefined | A timestamp that indicates when the application was last updated. |
Name | string | undefined | The name of the application. |
OwnerAccountId | string | undefined | The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID). |
ProxyType | ProxyType | undefined | The proxy type of the proxy created within the application. |
State | ApplicationState | undefined | The current state of the application. |
Tags | Record<string, string> | undefined | The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair. |
VpcId | string | undefined | The ID of the virtual private cloud (VPC). |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The user does not have sufficient access to perform this action. |
InternalServerException | server | An unexpected error occurred while processing the request. |
ResourceNotFoundException | client | The request references a resource that does not exist. |
ThrottlingException | client | Request was denied because the request was throttled. |
ValidationException | client | The input does not satisfy the constraints specified by an Amazon Web Service. |
MigrationHubRefactorSpacesServiceException | Base exception class for all service exceptions from MigrationHubRefactorSpaces service. |